The ComponentPath contains an array of components, organized from leaf to root. It allows the user to perform queries and operations along that path. More...

Inheritance diagram for HPS.ComponentPath:
HPS.Sprocket HPS.Object

Public Member Functions

HPS.ComponentPath Append (HPS.Component in_component)
 Appends the supplied Component into this object. Same as operator+= function. More...
 
HPS.ComponentPath Append (HPS.ComponentPath in_path)
 Appends the supplied key into this object. Same as operator+= function. More...
 
HPS.ComponentPath Append (HPS.Component[] in_components)
 Appends the supplied key into this object. Same as operator+= function. More...
 
 ComponentPath ()
 Creates an uninitialized Component path that refers to no database objects. More...
 
 ComponentPath (HPS.Component[] in_components)
 Creates a new ComponentPath object based on the supplied path. More...
 
 ComponentPath (HPS.ComponentPath in_that)
 Copies in_that into this component path. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ComponentPath in_that)
 Check if the source ComponentPath is equivalent to this object. More...
 
HPS.Component[] GetComponents ()
 Gets the components defining this ComponentPath. More...
 
override int GetHashCode ()
 
HPS.KeyPath[] GetKeyPaths ()
 Gets the KeyPath objects corresponding to this ComponentPath. These key paths will include all possible paths which include the path components and all Canvas, Layout and View paths which include the Model which contains the path components. More...
 
HPS.KeyPath[] GetKeyPaths (HPS.Canvas in_canvas, ulong in_layer)
 Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More...
 
HPS.KeyPath[] GetKeyPaths (HPS.Canvas in_canvas)
 Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer. More...
 
void Hide (HPS.Canvas in_canvas, ulong in_layer)
 Hides this ComponentPath under the given Canvas in the specified layer. More...
 
void Hide (HPS.Canvas in_canvas)
 Hides this ComponentPath under the given Canvas in the specified layer. More...
 
void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options)
 Highlights this ComponentPath with the provided options under the given Canvas in layer zero. More...
 
void Highlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options)
 Highlights this ComponentPath with the provided options under the given Canvas in the specified layer. More...
 
bool IsHidden (HPS.Canvas in_canvas, ulong in_layer)
 Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden. More...
 
bool IsHidden (HPS.Canvas in_canvas)
 Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden. More...
 
void Isolate (HPS.Canvas in_canvas, ulong in_layer)
 Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More...
 
void Isolate (HPS.Canvas in_canvas)
 Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.ComponentPath in_that)
 Copies the supplied path into this object. More...
 
HPS.ComponentPath SetComponents (HPS.Component[] in_components)
 Copies an array of components into this object. More...
 
void Show (HPS.Canvas in_canvas, ulong in_layer)
 Shows this ComponentPath under the given Canvas in the specified layer. More...
 
void Show (HPS.Canvas in_canvas)
 Shows this ComponentPath under the given Canvas in the specified layer. More...
 
void Unhighlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_options)
 Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero. More...
 
void Unhighlight (HPS.Canvas in_canvas)
 Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero. More...
 
void Unhighlight (HPS.Canvas in_canvas, ulong in_layer, HPS.HighlightOptionsKit in_options)
 Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer. More...
 
void Unhighlight (HPS.Canvas in_canvas, ulong in_layer)
 Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer. More...
 
- Public Member Functions inherited from HPS.Sprocket
override void Dispose ()
 
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 

Static Public Member Functions

static void Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas, ulong in_layer)
 
static void Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas)
 
static bool operator!= (HPS.ComponentPath a, HPS.ComponentPath b)
 
static bool operator== (HPS.ComponentPath a, HPS.ComponentPath b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Sprocket
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The ComponentPath contains an array of components, organized from leaf to root. It allows the user to perform queries and operations along that path.

Constructor & Destructor Documentation

HPS.ComponentPath.ComponentPath ( )
inline

Creates an uninitialized Component path that refers to no database objects.

HPS.ComponentPath.ComponentPath ( HPS.Component[]  in_components)
inline

Creates a new ComponentPath object based on the supplied path.

Parameters
in_componentsAn array of components arranged from leaf to root.
HPS.ComponentPath.ComponentPath ( HPS.ComponentPath  in_that)
inline

Copies in_that into this component path.

Member Function Documentation

HPS.ComponentPath HPS.ComponentPath.Append ( HPS.Component  in_component)
inline

Appends the supplied Component into this object. Same as operator+= function.

Parameters
in_componentThe Component to be appended to this.
Returns
A reference to this object.
HPS.ComponentPath HPS.ComponentPath.Append ( HPS.ComponentPath  in_path)
inline

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_pathThe ComponentPath to be appended to this.
Returns
A reference to this object.
HPS.ComponentPath HPS.ComponentPath.Append ( HPS.Component[]  in_components)
inline

Appends the supplied key into this object. Same as operator+= function.

Parameters
in_componentsThe ComponentArray to be appended to this.
Returns
A reference to this object.
bool HPS.ComponentPath.Equals ( HPS.ComponentPath  in_that)
inline

Check if the source ComponentPath is equivalent to this object.

Parameters
in_thatThe source ComponentPath to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
HPS.Component [] HPS.ComponentPath.GetComponents ( )
inline

Gets the components defining this ComponentPath.

Returns
The components defining this ComponentPath.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( )
inline

Gets the KeyPath objects corresponding to this ComponentPath. These key paths will include all possible paths which include the path components and all Canvas, Layout and View paths which include the Model which contains the path components.

Returns
All KeyPath objects for this component path.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.

Parameters
in_canvasThe Canvas the returned KeyPath objects should reference.
in_layerThe layer under the provided Canvas the returned KeyPath objects should reference.
Returns
The KeyPath objects for this component path which are included by the specified Canvas and layer.
HPS.KeyPath [] HPS.ComponentPath.GetKeyPaths ( HPS.Canvas  in_canvas)
inline

Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.

Parameters
in_canvasThe Canvas the returned KeyPath objects should reference.
Returns
The KeyPath objects for this component path which are included by the specified Canvas and layer.
void HPS.ComponentPath.Hide ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Hides this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to hide the ComponentPath.
in_layerThe layer under the provided Canvas in which to hide the ComponentPath.
void HPS.ComponentPath.Hide ( HPS.Canvas  in_canvas)
inline

Hides this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to hide the ComponentPath.
void HPS.ComponentPath.Highlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlights this ComponentPath with the provided options under the given Canvas in layer zero.

Parameters
in_canvasThe Canvas in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
void HPS.ComponentPath.Highlight ( HPS.Canvas  in_canvas,
ulong  in_layer,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to perform the highlight.
in_layerThe layer under the provided Canvas in which to perform the highlight.
in_optionsThe options to use to perform the highlight.
bool HPS.ComponentPath.IsHidden ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden.

Parameters
in_canvasThe Canvas in which to check whether the specified path is hidden.
in_layerThe layer under the provided Canvas in which to check whether the specified path is hidden.
Returns
true if this path is hidden, false otherwise.
bool HPS.ComponentPath.IsHidden ( HPS.Canvas  in_canvas)
inline

Indicates whether this ComponentPath under the given Canvas in the specified layer is hidden. Note that even if a path is hidden, it's possible that paths descending from this path may not be hidden.

Parameters
in_canvasThe Canvas in which to check whether the specified path is hidden.
Returns
true if this path is hidden, false otherwise.
void HPS.ComponentPath.Isolate ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to isolate the ComponentPath.
in_layerThe layer under the provided Canvas in which to isolate the ComponentPath.
void HPS.ComponentPath.Isolate ( HPS.Canvas  in_canvas)
inline

Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to isolate the ComponentPath.
override HPS.Type HPS.ComponentPath.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.ComponentPath.Set ( HPS.ComponentPath  in_that)
inline

Copies the supplied path into this object.

Parameters
in_thatThe source of the copy.
HPS.ComponentPath HPS.ComponentPath.SetComponents ( HPS.Component[]  in_components)
inline

Copies an array of components into this object.

Parameters
in_componentsThe source array, assumed to be arranged from leaf to root.
Returns
A reference to this object.
void HPS.ComponentPath.Show ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Shows this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to show the ComponentPath.
in_layerThe layer under the provided Canvas in which to show the ComponentPath.
void HPS.ComponentPath.Show ( HPS.Canvas  in_canvas)
inline

Shows this ComponentPath under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to show the ComponentPath.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
in_optionsThe options to use to perform the unhighlight.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas)
inline

Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas,
ulong  in_layer,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
in_layerThe layer under the provided Canvas in which to perform the unhighlight.
in_optionsThe options to use to perform the unhighlight.
void HPS.ComponentPath.Unhighlight ( HPS.Canvas  in_canvas,
ulong  in_layer 
)
inline

Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.

Parameters
in_canvasThe Canvas in which to perform the unhighlight.
in_layerThe layer under the provided Canvas in which to perform the unhighlight.

The documentation for this class was generated from the following file:
  • internals/hps_sprk/source/cs/HPS.ComponentPath.cs