Difference between revisions of "VS:VM MoveToLayer"

From VectorMEP
Jump to navigation Jump to search
m
m
Line 1: Line 1:
 
{{DISPLAYTITLE:VS:VM_MoveToLayer}}
 
{{DISPLAYTITLE:VS:VM_MoveToLayer}}
  
−
Attaches the selected objects to a given layer
+
{{LocationMain|category=LocationVS|specific=}}
 +
__TOC__
 +
<vwDoc>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<desc>
 +
Displays an alert dialog which alerts the user to a condition or situation that requires the user's decision and input before preceding; such as an impending action with potentially destructive or irreversible consequences. The message can be in the form of a question.
 +
</desc>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<def>
 +
<funcDef lang="vs">
 +
FUNCTION AlertQuestion(question:STRING; advice:STRING; defaultButton:INTEGER; OKOverrideText:STRING; CancelOverrideText:STRING; customButtonAText:STRING; customButtonBText:STRING) : INTEGER;
 +
</funcDef>
 +
<funcDef lang="py">
 +
def vs.AlertQuestion(question, advice, defaultButton, OKOverrideText, CancelOverrideText, customButtonAText, customButtonBText):
 +
    return INTEGER
 +
</funcDef>
 +
</def>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<params>
 +
<lineList ident=1>
 +
<line>
 +
question
 +
STRING
 +
The question to display
 +
</line>
 +
<line>
 +
advice
 +
STRING
 +
The text to be added in a smaller font under the main information/message
 +
</line>
 +
<line>
 +
defaultButton
 +
INTEGER
 +
Specifies which button is to be made the default
 +
0: the negative(Cancel) button is the default
 +
1: the positive(Ok) button is the default
 +
2: custom button A is the default
 +
3: custom button B is the default
 +
</line>
 +
<line>
 +
OKOverrideText
 +
STRING
 +
Specifies a string to use in overriding the 'OK' string
 +
</line>
 +
<line>
 +
CancelOverrideText
 +
STRING
 +
Specifies a string to use in overriding the 'Cancel' string
 +
</line>
 +
<line>
 +
customButtonAText
 +
STRING
 +
Specifies a string to use for an optional custom button A
 +
</line>
 +
<line>
 +
customButtonBText
 +
STRING
 +
Specifies a string to use for a second optional custom button B
 +
</line>
 +
</lineList>
 +
</params>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<return>
 +
Return Values
 +
0:  the negative(Cancel) button was hit
 +
1:  the positive(Ok) button was hit
 +
2:  custom button A was hit
 +
3:  custom button B was hit</return>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<remark>
 +
Examples of all of the messaging techniques:&lt;pre&gt;
 +
AlertQuestion uses the exclamation icon, when really it should use the question icon.
 +
</remark>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<sample>
 +
{{AlertDialogsAndMessages}}
 +
</sample>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<seeAlso>
 +
VS Functions:
 +
[[VS:AlertInform]]
 +
| [[VS:AlertCritical]]
 +
</seeAlso>
 +
 
 +
-----------------------------------------------------------------------------------------------------------
 +
<version>
 +
Availability: from VectorWorks12.0
 +
 
 +
</version>
 +
 
 +
</vwDoc>
 +
 
 
[[Category:VS Function Reference:Object Editing]]
 
[[Category:VS Function Reference:Object Editing]]

Revision as of 06:59, 16 November 2020


Template:LocationMain

<vwDoc>

<desc> Displays an alert dialog which alerts the user to a condition or situation that requires the user's decision and input before preceding; such as an impending action with potentially destructive or irreversible consequences. The message can be in the form of a question. </desc>

<def> <funcDef lang="vs"> FUNCTION AlertQuestion(question:STRING; advice:STRING; defaultButton:INTEGER; OKOverrideText:STRING; CancelOverrideText:STRING; customButtonAText:STRING; customButtonBText:STRING) : INTEGER; </funcDef> <funcDef lang="py"> def vs.AlertQuestion(question, advice, defaultButton, OKOverrideText, CancelOverrideText, customButtonAText, customButtonBText): 

   return INTEGER

</funcDef> </def>

<params> <lineList ident=1> <line> question STRING The question to display </line> <line> advice STRING The text to be added in a smaller font under the main information/message </line> <line> defaultButton INTEGER Specifies which button is to be made the default 0: the negative(Cancel) button is the default 1: the positive(Ok) button is the default 2: custom button A is the default 3: custom button B is the default </line> <line> OKOverrideText STRING Specifies a string to use in overriding the 'OK' string </line> <line> CancelOverrideText STRING Specifies a string to use in overriding the 'Cancel' string </line> <line> customButtonAText STRING Specifies a string to use for an optional custom button A </line> <line> customButtonBText STRING Specifies a string to use for a second optional custom button B </line> </lineList> </params>

<return> Return Values 0: the negative(Cancel) button was hit 1: the positive(Ok) button was hit 2: custom button A was hit 3: custom button B was hit</return>

<remark> Examples of all of the messaging techniques:<pre> AlertQuestion uses the exclamation icon, when really it should use the question icon. </remark>

<sample> Template:AlertDialogsAndMessages </sample>

<seeAlso> VS Functions: VS:AlertInform | VS:AlertCritical </seeAlso>

<version> Availability: from VectorWorks12.0

</version>

</vwDoc>

Retrieved from "https://www.vectormep.com/Wiki/index.php?title=VS:VM_MoveToLayer&oldid=120"