Difference between revisions of "SHIP:Sail:set"

From Serious Documentation
Jump to: navigation, search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{SailFuncTableStart|}}<onlyinclude>
 
{{SailFuncTableStart|}}<onlyinclude>
|{{SailFunc|set}}||{{DataType|Node}} srcNode||style="text-align:center;"|v5.1.0||Set a property {{v5}}</onlyinclude>
+
|{{SailFunc|set}}||||style="text-align:center;"|v5.1.0||Set a property value{{v5}}</onlyinclude>
 
|}
 
|}
 
== See Also: ==
 
== See Also: ==
Line 9: Line 9:
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
*{{SailFunc|getChild}}, {{SailFunc|getChildIndex}}
 
== Prototype ==
 
== Prototype ==
<code>{{SailFunc|set}} {{DataType|Node}} node_prop, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} value, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} peers_value);</code>
+
<code>{{SailFunc|set}} {{DataType|Node}}.property, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} value, {{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}} peers_value);</code>
  
 
== Parameters/Return Value ==
 
== Parameters/Return Value ==
Line 17: Line 17:
 
! scope="col" style="text-align:left" | Description
 
! scope="col" style="text-align:left" | Description
 
|-
 
|-
|node_prop||{{DataType|Node}}||Property to set
+
|.property||{{DataType|Node}}||Property to set
 
|-
 
|-
 
|value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value
 
|value||{{DataType|Integer}}/{{DataType|String}}/{{DataType|Boolean}}||new property value

Revision as of 14:01, 11 October 2016

Function Returns Introduced Description
set v5.1.0 Set a property valueBadge SHIPv5.gif

See Also:

Prototype

set Node.property, Integer/String/Boolean value, Integer/String/Boolean peers_value);

Parameters/Return Value

Parameter Data Type Description
.property Node Property to set
value Integer/String/Boolean new property value
peers_value Integer/String/Boolean new property value for peers
Return no return value

Detailed Description

This function sets the property to the value indicated and sets the property of the nodes peers to the indicated peers_value.

Examples

Example Results Notes
set(pHome.visible, true, false); Set home page to visible and all other pages to non-visible