IDLitTool::FindIdentifiers

The IDLitTool::FindIdentifiers function method allows you to retrieve the full identifiers for items within the tool container.

Warning
The FindIdentifiers method recurses through the entire object hierarchy of the specified object, which may be slow for large container hierarchies. If you find it necessary to call FindIdentifiers multiple times, it may be more efficient to use a single call with one or more wildcards ("*") to return all relevant identifiers, and then perform the necessary searches using the returned list.

Syntax

Result = Obj->[IDLitTool::]FindIdentifiers([Pattern] [, /ANNOTATIONS] [, COUNT=variable] [, /DATA_MANAGER] [, /FILE_READERS] [, /FILE_WRITERS] [, /LEAF_NODES] [, /MANIPULATORS] [, /OPERATIONS] [, /VISUALIZATIONS] )

Return Value

Returns a scalar string or string array containing the full object identifiers for all items matching the Pattern. If no object identifiers are matched, the function returns a scalar null string.

Arguments

Pattern

A string specifying a search pattern to be used for filtering the returned object identifiers. Only object identifiers that match Pattern are returned. Matching is case insensitive. If Pattern is not supplied, identifiers for all objects within the object on which this method is called are returned. See STRMATCH for a description of the rules used when matching patterns. See Retrieving Component Identifiers (iTool Developer's Guide) for additional information and examples.

Note
Objects for which the PRIVATE property contains a True value are not included in the Result. Only objects that subclass from IDLitComponent can be marked as private.

Keywords

ANNOTATIONS

Set this keyword to only return identifiers for items within the annotation layer of all views within the graphics window.

COUNT

Set this keyword equal to a named variable that will contain the number of identifiers in Result.

DATA_MANAGER

Set this keyword to only return identifiers for items within the Data Manager container.

FILE_READERS

Set this keyword to only return identifiers for items within the File Readers container.

FILE_WRITERS

Set this keyword to only return identifiers for items within the File Writers container.

LEAF_NODES

Set this keyword to return only leaf nodes. Leaf nodes are objects which are either not a container, or are an empty container.

Note
If all of the objects within a container are marked as PRIVATE, then that container is considered a leaf node. Only objects that subclass from IDLitComponent can be marked as private.

MANIPULATORS

Set this keyword to only return identifiers for items within the Manipulators container.

OPERATIONS

Set this keyword to only return identifiers for items within the Operations container.

VISUALIZATIONS

Set this keyword to only return identifiers for items within the Visualization layer of all views within the graphics window.

Example

This example finds the plot visualization and changes the color:

IPLOT, RANDOMU(s,100) 
void = IGETCURRENT(TOOL=oTool) 
 
; Find the Plot visualization and change the color. 
id = oTool->FindIdentifiers('*plot*', /VISUALIZATIONS) 
 
void = oTool->DoSetProperty(id, 'COLOR', [255,0,0])

This example finds the file open operation and loads in an image:

IIMAGE 
void = IGETCURRENT(TOOL=oTool) 
 
; Find the File Open operation and open a file. 
id = oTool->FindIdentifiers('*File/Open*', /OPERATIONS) 
 
oOp = oTool->GetByIdentifier(id) 
oOp->SetProperty, SHOW_EXECUTION_UI=0, $ 
   FILENAMES=FILEPATH('rose.jpg', SUBDIR=['examples','data']) 
void = oTool->DoAction(id) 
oOp->SetProperty, SHOW_EXECUTION_UI=1

Version History


6.1	Introduced