BrowseFilter Class Reference

Option object to filter IClientNode.Browse results. More...

Static Public Member Functions
static BrowseFilter	Create (ReferenceType referenceType)
	Creates a simple filter. More...
static BrowseFilter	Create (BrowseDirection browseDirection, ReferenceType referenceType, int maxReferences, bool includeSubTypes, NodeClass nodeClasses)
	Creates a filter based on the given configuration. More...

Properties
static BrowseFilter	Default [get]
	Gets the default filter for hierarchical reference including all data.
bool	IncludeSubTypes [get, set]
	Defines whether derived node types are also included.
NodeClass	NodeClasses [get, set]
	Gets/sets the node classes to browse. More...
int	MaxReferences [get, set]
	Gets/sets the limit for number of references from the start node. More...
ReferenceType	ReferenceType [get, set]
	Gets/sets the type of reference to be browsed for. More...
BrowseDirection	BrowseDirection [get, set]
	Gets/sets the directions of the references to return. More...

Detailed Description

Option object to filter IClientNode.Browse results.

Member Function Documentation

Create() [1/2]

static BrowseFilter Create ( BrowseDirection  browseDirection, ReferenceType  referenceType, int  maxReferences, bool  includeSubTypes, NodeClass  nodeClasses  )

static

Creates a filter based on the given configuration.

Parameters

browseDirection	Directions of the references to return.
referenceType	Reference type for the browse, i.e. only items which have the hasChild (or similar) relationship.
maxReferences	Limit for number of references from the start node, elements exceeding the limit will not be included in the result.
includeSubTypes	Should sub-types of the starting node be included or excluded from the browse.
nodeClasses	Bitwise AND of the desired node classes.

Create() [2/2]

static BrowseFilter Create ( ReferenceType  referenceType )

static

Creates a simple filter.

Parameters

referenceType

Reference type for the browse, i.e. only items which have the hasChild (or similar) relationship.

Property Documentation

BrowseDirection

BrowseDirection BrowseDirection

getset

Gets/sets the directions of the references to return.

Default is BrowseDirection.Forward.

MaxReferences

int MaxReferences

getset

Gets/sets the limit for number of references from the start node.

Default is 10000.

NodeClasses

NodeClass NodeClasses

getset

Gets/sets the node classes to browse.

Default is NodeClass.Unspecified which means all node classes are put into the IClientNode.Browse result.

ReferenceType

ReferenceType ReferenceType

getset

Gets/sets the type of reference to be browsed for.

See Namespace0.ReferenceTypeId for possible browsable references.

Default is ReferenceType.Hierarchical.