RhinoObject.Select (Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)

Public Class

Selects an object.

Namespace: Rhino.DocObjects

Assembly: RhinoCommon (in RhinoCommon.dll)

**Since:**5.0

Syntax

public int Select(
  bool on,
  bool syncHighlight,
  bool persistentSelect,
  bool ignoreGripsState,
  bool ignoreLayerLocking,
  bool ignoreLayerVisibility
)

Parameters

on

Type:System.Boolean
The new selection state; true activates selection.

syncHighlight

Type:System.Boolean
If true, then the object is highlighted if it is selected and unhighlighted if is not selected.

Highlighting can be and stay out of sync, as its specification is independent.

persistentSelect

Type:System.Boolean
Objects that are persistently selected stay selected when a command terminates.

ignoreGripsState

Type:System.Boolean
If true, then objects with grips on can be selected. If false, then the value returned by the object’s IsSelectableWithGripsOn() function decides if the object can be selected when it has grips turned on.

ignoreLayerLocking

Type:System.Boolean
If true, then objects on locked layers can be selected. If false, then objects on locked layers cannot be selected.

ignoreLayerVisibility

Type:System.Boolean
If true, then objects on hidden layers can be selectable. If false, then objects on hidden layers cannot be selected.

Return Value

Type:Int32

0: object is not selected.

1: object is selected.

2: object is selected persistently.

Remarks

Objects that are locked, hidden, or on locked or hidden layers cannot be selected. If IsSelectableWithGripsOn() returns false, then an that object is not selectable if it has grips turned on.