Class RapidSymbolSearchProperties

Defines the search properties for a symbol search.

Inheritance

System.Object

RapidSymbolSearchProperties

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public class RapidSymbolSearchProperties

Constructors

RapidSymbolSearchProperties()

Creates a symbol search property object.

Declaration

public RapidSymbolSearchProperties()

RapidSymbolSearchProperties(SymbolSearchMethod)

Creates a symbol search property object.

Declaration

public RapidSymbolSearchProperties(SymbolSearchMethod method)

Parameters

Type	Name	Description
SymbolSearchMethod	method	Search method.

RapidSymbolSearchProperties(SymbolSearchMethod, SymbolTypes)

Creates a symbol search property object.

Declaration

public RapidSymbolSearchProperties(SymbolSearchMethod method, SymbolTypes types)

Parameters

Type	Name	Description
SymbolSearchMethod	method	Search method.
SymbolTypes	types	Types to search for.

RapidSymbolSearchProperties(SymbolSearchMethod, SymbolTypes, Boolean, Boolean, Boolean, Boolean)

Creates a symbol search property object.

Declaration

public RapidSymbolSearchProperties(SymbolSearchMethod method, SymbolTypes types, bool recursive, bool local, bool global, bool inUse)

Parameters

Type	Name	Description
SymbolSearchMethod	method	Search method.
SymbolTypes	types	Types to search for.
System.Boolean	recursive	Recursive search.
System.Boolean	local	Include local parameters.
System.Boolean	global	Include global parameters.
System.Boolean	inUse	Include only symbols that are in use.

Properties

GlobalSymbols

Include global symbols.

Declaration

public bool GlobalSymbols { get; set; }

Property Value

Type	Description
System.Boolean

InUse

Include symbols in use.

Declaration

public bool InUse { get; set; }

Property Value

Type	Description
System.Boolean

LocalSymbols

Include local symbols.

Declaration

public bool LocalSymbols { get; set; }

Property Value

Type	Description
System.Boolean

Recursive

Search recursive.

Declaration

public bool Recursive { get; set; }

Property Value

Type	Description
System.Boolean

SearchMethod

Search method.

Declaration

public SymbolSearchMethod SearchMethod { get; set; }

Property Value

Type	Description
SymbolSearchMethod

Types

Types to search for.

Declaration

public SymbolTypes Types { get; set; }

Property Value

Type	Description
SymbolTypes

Methods

CreateDefault()

Creates the default search properties

Declaration

public static RapidSymbolSearchProperties CreateDefault()

Returns

Type	Description
RapidSymbolSearchProperties	Default search properties for NO kind of symbol. MUST set Type!!!

CreateDefaultForData()

Creates default properties for a data search.

Declaration

public static RapidSymbolSearchProperties CreateDefaultForData()

Returns

Type	Description
RapidSymbolSearchProperties	Default search properties for a data search.

CreateDefaultForData(Boolean)

Creates default properties for a data search.

Declaration

public static RapidSymbolSearchProperties CreateDefaultForData(bool recursive)

Parameters

Type	Name	Description
System.Boolean	recursive	Recursive search.

Returns

Type	Description
RapidSymbolSearchProperties	Default search properties for a data search.

CreateDefaultForRoutine()

Creates default properties for a data search.

Declaration

public static RapidSymbolSearchProperties CreateDefaultForRoutine()

Returns

Type	Description
RapidSymbolSearchProperties	Default search properties for a data search.

CreateDefaultForRoutine(Boolean)

Creates default properties for a data search.

Declaration

public static RapidSymbolSearchProperties CreateDefaultForRoutine(bool recursive)

Parameters

Type	Name	Description
System.Boolean	recursive	Recursive search.

Returns

Type	Description
RapidSymbolSearchProperties	Default search properties for a data search.