VS:GetCVis: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 59: Line 59:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<sample>
<sample>
==== VectorScript ====
<code lang="pas">
<code lang="pas">
PROCEDURE Example;
PROCEDURE Example;
Line 65: Line 66:
END;
END;
RUN(Example);</code>
RUN(Example);</code>
==== Python ====
<code lang="py">
def Example():
vs.Message(vs.GetCVis('Dimension'))
Example()
</code>
</sample>
</sample>



Latest revision as of 16:31, 19 June 2014

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Returns the visibility status of the specified class.

FUNCTION GetCVis(
className :STRING) : INTEGER;
def vs.GetCVis(className):
    return INTEGER

Parameters

className STRING Name of class.

Return Value

Returns one of:

Visibility Index Value
Visible 0
Hidden -1
Grayed 2

Remarks

Also, though a warning is generated, passing a string to a non-existent class returns 0.

Example

VectorScript

PROCEDURE Example;
BEGIN
Message(GetCVis('Dimension'));
END;
RUN(Example);

Python

def Example():
	vs.Message(vs.GetCVis('Dimension'))
Example()

Version

Availability: from All Versions