VS:GetCVis

From Vectorworks Developer
Revision as of 14:30, 12 August 2013 by Root (talk | contribs) (1 revision)
Jump to navigation Jump to search

.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

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

Version

Availability: from All Versions