ObjectTable.FindByUserString Method (String, String, Boolean, Boolean, Boolean, ObjectType)

ObjectTableFindByUserString Method (String, String, Boolean, Boolean, Boolean, ObjectType)

Finds all objects whose UserString matches the search patterns.

Namespace:  Rhino.DocObjects.Tables
Assembly:  RhinoCommon (in RhinoCommon.dll)
Since: 5.0
Syntax
Copy
public RhinoObject[] FindByUserString(
	string key,
	string value,
	bool caseSensitive,
	bool searchGeometry,
	bool searchAttributes,
	ObjectType filter
)
Public Function FindByUserString ( 
	key As String,
	value As String,
	caseSensitive As Boolean,
	searchGeometry As Boolean,
	searchAttributes As Boolean,
	filter As ObjectType
) As RhinoObject()

Parameters

key
Type: SystemString
Search pattern for UserString keys (supported wildcards are: ? = any single character, * = any sequence of characters).
value
Type: SystemString
Search pattern for UserString values (supported wildcards are: ? = any single character, * = any sequence of characters).
caseSensitive
Type: SystemBoolean
If true, string comparison will be case sensitive.
searchGeometry
Type: SystemBoolean
If true, UserStrings attached to the geometry of an object will be searched.
searchAttributes
Type: SystemBoolean
If true, UserStrings attached to the attributes of an object will be searched.
filter
Type: Rhino.DocObjectsObjectType
Object type filter.

Return Value

Type: RhinoObject
An array of all objects whose UserString matches with the search patterns or null when no such objects could be found.
See Also

M:Rhino.DocObjects.Tables.ObjectTable.FindByUserString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean,Rhino.DocObjects.ObjectType)