
Public Types | |
enum | PathType : uint { PathType.Complete = 0x00000000, PathType.Unique = 0x00000001 } |
Enumerates the types of ComponentPaths. More... | |
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... | |
HPS.Component | At (ulong in_index) |
HPS.Component | Back () |
ComponentPath () | |
Creates an uninitialized ComponentPath 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 ComponentPath. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ComponentPath is empty. More... | |
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 | Front () |
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, bool in_remove_existing) |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero. 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, bool in_remove_existing) |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer. 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... | |
void | Insert (ulong in_index, HPS.Component in_item) |
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, HPS.Component.Visibility in_subtree_visibility) |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. 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. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. 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. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More... | |
HPS.Component | PopBack () |
HPS.Component | PopFront () |
HPS.ComponentPath | PushBack (HPS.Component in_component) |
HPS.ComponentPath | PushBack (HPS.ComponentPath in_path) |
Appends the supplied key into this object. Same as operator+= function. More... | |
HPS.ComponentPath | PushBack (HPS.Component[] in_components) |
Appends the supplied key into this object. Same as operator+= function. More... | |
HPS.ComponentPath | PushFront (HPS.Component in_component) |
void | Remove (HPS.Component in_item) |
void | Remove (ulong in_index) |
HPS.ComponentPath | Reverse () |
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, HPS.Component.Visibility in_subtree_visibility) |
Shows this ComponentPath under the given Canvas in the specified layer. 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... | |
ulong | Size () |
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... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
virtual 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, HPS.Component.Visibility in_subtree_visibility) |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. More... | |
static void | Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas, ulong in_layer) |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. More... | |
static void | Isolate (HPS.ComponentPath[] in_components_to_be_isolated, HPS.Canvas in_canvas) |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath. More... | |
static bool | operator!= (HPS.ComponentPath a, HPS.ComponentPath b) |
static bool | operator== (HPS.ComponentPath a, HPS.ComponentPath b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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.
Member Enumeration Documentation
enum HPS.ComponentPath.PathType : uint |
Enumerates the types of ComponentPaths.
Enumerator | |
---|---|
Complete |
The ComponentPath contains all components between leaf and root. |
Unique |
The ComponentPath contains only components which are unique to this request, omitting ambiguous entries. |
Constructor & Destructor Documentation
|
inline |
Creates an uninitialized ComponentPath that refers to no database objects.
|
inline |
Creates a new ComponentPath object based on the supplied path.
- Parameters
-
in_components An array of components arranged from leaf to root.
|
inline |
Copies in_that into this ComponentPath.
Member Function Documentation
|
inline |
Appends the supplied Component into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_component The Component to be appended to this.
- Returns
- A reference to this object.
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_path The ComponentPath to be appended to this.
- Returns
- A reference to this object.
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Deprecated:
- This function exists for compatibility. Use ComponentPath.PushBack instead.
- Parameters
-
in_components The ComponentArray to be appended to this.
- Returns
- A reference to this object.
|
inlinevirtual |
Indicates whether this ComponentPath is empty.
- Returns
- true if no components are set on the path, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ComponentPath is equivalent to this object.
- Parameters
-
in_that The source ComponentPath to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Gets the components defining this ComponentPath.
- Returns
- The components defining this ComponentPath.
|
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 ComponentPath.
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
- Parameters
-
in_canvas The Canvas the returned KeyPath objects should reference. in_layer The layer under the provided Canvas the returned KeyPath objects should reference.
- Returns
- The KeyPath objects for this ComponentPath which are included by the specified Canvas and layer.
|
inline |
Gets the KeyPath objects corresponding to this ComponentPath which are included by the specified Canvas and layer.
- Returns
- The KeyPath objects for this ComponentPath which are included by the specified Canvas and layer.
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to hide the ComponentPath. in_layer The layer under the provided Canvas in which to hide the ComponentPath.
|
inline |
Hides this ComponentPath under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to hide the ComponentPath.
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_options The options to use to perform the highlight. in_remove_existing Indicates whether this highlight should flush existing highlights at the specified path for the desired overlay type. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_options The options to use to perform the highlight.
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_layer The layer under the provided Canvas in which to perform the highlight. in_options The options to use to perform the highlight. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
|
inline |
Highlights this ComponentPath with the provided options under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to perform the highlight. in_layer The layer under the provided Canvas in which to perform the highlight. in_options The options to use to perform the highlight. If HPS.ComponentPath.Isolate(), HPS.ComponentPath.Hide(), or HPS.ComponentPath.Show() have been called on this ComponentPath, in_remove_existing should be set to false so that it doesn't override those visibility states.
|
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_canvas The Canvas in which to check whether the specified path is hidden. in_layer The layer under the provided Canvas in which to check whether the specified path is hidden.
- Returns
- true if this path is hidden, false otherwise.
|
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_canvas The Canvas in which to check whether the specified path is hidden.
- Returns
- true if this path is hidden, false otherwise.
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath. in_subtree_visibility Dictates how Isolate will interact with the visibility of components in the tree under this ComponentPath.
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath.
|
inline |
Shows only this ComponentPath and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of this isolated ComponentPath must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_canvas The Canvas in which to isolate the ComponentPath.
|
inlinestatic |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_components_to_be_isolated The ComponentPathArray to isolate. in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath. in_subtree_visibility Dictates how Isolate will interact with the visibility of components in the tree under this ComponentPath.
|
inlinestatic |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_components_to_be_isolated The ComponentPathArray to isolate. in_canvas The Canvas in which to isolate the ComponentPath. in_layer The layer under the provided Canvas in which to isolate the ComponentPath.
|
inlinestatic |
Shows only the objects in the supplied ComponentPathArray and hides all other Component objects under the given Canvas in the specified layer. As this is implemented using a style applied with Drawing.Overlay.OverlayWithZ, a future highlight of any ComponentPath in the supplied ComponentPathArray must be applied with Drawing.Overlay.OverlayWithZ or Drawing.Overlay.Overlay so that the highlight appears on top of the isolated ComponentPath.
- Parameters
-
in_components_to_be_isolated The ComponentPathArray to isolate. in_canvas The Canvas in which to isolate the ComponentPath.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_path The ComponentPath to be appended to this.
- Returns
- A reference to this object.
|
inline |
Appends the supplied key into this object. Same as operator+= function.
- Parameters
-
in_components The ComponentArray to be appended to this.
- Returns
- A reference to this object.
|
inline |
Copies the supplied path into this object.
- Parameters
-
in_that The source of the copy.
|
inline |
Copies an array of components into this object.
- Parameters
-
in_components The source array, assumed to be arranged from leaf to root.
- Returns
- A reference to this object.
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to show the ComponentPath. in_layer The layer under the provided Canvas in which to show the ComponentPath. in_subtree_visibility Dictates how Show will interact with the visibility of components in the tree under this ComponentPath.
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to show the ComponentPath. in_layer The layer under the provided Canvas in which to show the ComponentPath.
|
inline |
Shows this ComponentPath under the given Canvas in the specified layer.
- Parameters
-
in_canvas The Canvas in which to show the ComponentPath.
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the unhighlight. in_options The options to use to perform the unhighlight.
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in layer zero.
- Parameters
-
in_canvas The Canvas in which to perform the unhighlight.
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
|
inline |
Unhighlights this ComponentPath with the provided options under the given Canvas in the specified layer.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.ComponentPath.cs