Difference between revisions of "VS:VM MoveToLayer"

From VectorMEP
Jump to navigation Jump to search
m
m
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:VS:VM_MoveToLayer}}
 
{{DISPLAYTITLE:VS:VM_MoveToLayer}}
 +
== Description ==
 +
Procedure VM_MoveToLayer moves the selected objects to a layer.<syntaxhighlight lang="pascal">
 +
PROCEDURE VM_MoveToLayer(
 +
    h    :Handle);
 +
</syntaxhighlight>
 +
== Parameters ==
 +
<dl><dd><table cellpadding="2" border="0"><tr>  <td valign="top">h</td>  <td></td>  <td valign="top">HANDLE</td>  <td> </td>  <td valign="top">Handle to layer.</td></tr></table></dd></dl>
  
−
{{LocationMain|category=LocationVS|specific=}}
+
== Remarks ==
−
__TOC__
+
When nill is passed as Layer handle, a dialog is presented with a list of all Layers to choose from.
−
<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>
 
−
 
 
−
-----------------------------------------------------------------------------------------------------------
 
−
<dl><dd><table cellpadding="2" border="0">
 
−
<tbody><tr>  <td valign="top">question</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">The question to display</td></tr>
 
−
<tr>  <td valign="top">advice</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">The text to be added in a smaller font under the main information/message</td></tr>
 
−
<tr>  <td valign="top">defaultButton</td>  <td></td>  <td valign="top">INTEGER</td>  <td> </td>  <td valign="top">Specifies which button is to be made the default</td></tr>
 
−
<tr>  <td valign="top">OKOverrideText</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">Specifies a string to use in overriding the 'OK' string</td></tr>
 
−
<tr>  <td valign="top">CancelOverrideText</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">Specifies a string to use in overriding the 'Cancel' string</td></tr>
 
−
<tr>  <td valign="top">customButtonAText</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">Specifies a string to use for an optional custom button A</td></tr>
 
−
<tr>  <td valign="top">customButtonBText</td>  <td></td>  <td valign="top">STRING</td>  <td> </td>  <td valign="top">Specifies a string to use for a second optional custom button B</td></tr>
 
−
</tbody></table></dd></dl>
 
−
 
 
−
<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>
 
  
 +
== Example ==
 +
<syntaxhighlight lang="pascal">
 +
PROCEDURE MoveToLayer;
 +
VAR
 +
    h : HANDLE;
 +
BEGIN
 +
    h := NIL;
 +
    {h := GetObject('LayerName'); in case of predefined layer}
 +
    IF VerifyLibraryRoutine('VM_MoveToLayer') THEN
 +
BEGIN
 +
IF (GetType(h) = 31) OR (h = NIL) THEN VM_MoveToLayer(h);
 +
        End
 +
    ELSE
 +
        Message('The routine VM_MoveToLayer is not available.');
 +
END;
 +
RUN(MoveToLayer);
 +
</syntaxhighlight>
 +
== Version ==
 +
Availability: from VectorMEP 2021
 
[[Category:VS Function Reference:Object Editing]]
 
[[Category:VS Function Reference:Object Editing]]
 +
__NOTOC__

Latest revision as of 08:54, 16 November 2020

Description

Procedure VM_MoveToLayer moves the selected objects to a layer.

PROCEDURE VM_MoveToLayer(
    h     :Handle);

Parameters

h HANDLE Handle to layer.

Remarks

When nill is passed as Layer handle, a dialog is presented with a list of all Layers to choose from.

Example

PROCEDURE MoveToLayer;
VAR
    h : HANDLE;
BEGIN
    h := NIL; 
    {h := GetObject('LayerName'); in case of predefined layer}
    IF VerifyLibraryRoutine('VM_MoveToLayer') THEN
		BEGIN
			IF (GetType(h) = 31) OR (h = NIL) THEN VM_MoveToLayer(h);
        End
    ELSE
        Message('The routine VM_MoveToLayer is not available.');
END;
RUN(MoveToLayer);

Version

Availability: from VectorMEP 2021

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