GH_ComponentServerFindObjectByName Method |
Find an object by name. Obsolete and hidden objects are ignored.
Only exact matches are included.
Namespace:
Grasshopper.Kernel
Assembly:
Grasshopper (in Grasshopper.dll)
Syntax public IGH_ObjectProxy FindObjectByName(
string name,
bool ignoreWhiteSpace,
bool ignoreCapitalisation
)
Public Function FindObjectByName (
name As String,
ignoreWhiteSpace As Boolean,
ignoreCapitalisation As Boolean
) As IGH_ObjectProxy
Parameters
- name
- Type: SystemString
Name to search for. Name may be prefixed by Category and Subcategory. - ignoreWhiteSpace
- Type: SystemBoolean
If true, whitespace is ignored during matching. - ignoreCapitalisation
- Type: SystemBoolean
If true, capitalisation is ignored during matching.
Return Value
Type:
IGH_ObjectProxyThe proxy that matches the name, or null if no such object could be found.
See Also