Click or drag to resize

RhinoObjectIsHighlighted Method

Check highlight state.

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
public int IsHighlighted(
	bool checkSubObjects


Type: SystemBoolean
If true and the entire object is not highlighted, and some subset of the object is highlighted, like some edges of a surface, then 3 is returned. If false and the entire object is not highlighted, then zero is returned.

Return Value

Type: Int32

0: object is not highlighted.

1: entire object is highlighted.

3: one or more proper sub-objects are highlighted.

Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.20
See Also