Gets a list of symbol objects that match a set of criteria.

S# Implementation
Copy 
public static IList<Symbol> GetMatchingSymbols( 
   string symbolSet, 
   string categoryFilter = null, 
   string searchText = null 
)

Parameters

symbolSet

Type: string

The name of the symbol set.

categoryFilter

Type: string

The partial or full name of the category to include (optional).

searchText

Type: string

Text used to compare the symbol's name.

Return Value

A list of Symbol objects that match the specified criteria.
Remarks
The Symbol class encapsulates the attributes that define the appearance and behavior of a specific Symbol page element. To apply these attributes to a Symbol page element, set the element's SymbolSet and SymbolID properties, as illustrated in the example.
Example
This example shows how to find a matching Symbol and set the properties of a Symbol element to use it. The Symbol control named 'mySymbol' is set to use the first Symbol Factory symbol in the 'Boilers' category with the word 'flames' in its name.
Copy 
 var symbols = WV.GetMatchingSymbols("Symbol Factory", "Boilers", "flames");
 var symbol = symbols[0];
 SETP("mySymbol@SymbolSet", symbol.ParentSymbolMap.SymbolSet);
 SETP("mySymbol@SymbolID", symbol.SymbolID);

See Also