REFERENCE MANUAL
The ImageDefinition class is a smart pointer to a database object. More...
Public Member Functions | |
override void | Dispose () |
ImageDefinition () | |
The default constructor creates an uninitialized ImageDefinition object. More... | |
ImageDefinition (HPS.Definition in_that) | |
This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
ImageDefinition (HPS.ImageDefinition in_that) | |
This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.ImageKit in_kit) |
Redefine the image for this ImageDefinition. More... | |
void | Show (out HPS.ImageKit out_kit) |
Shows the image for this ImageDefinition. More... | |
![]() | |
virtual void | Assign (HPS.Definition in_that) |
Associate this Definition with the same underlying impl as the source Definition. More... | |
Definition () | |
The default constructor creates an uninitialized Definition object. More... | |
Definition (HPS.Definition in_that) | |
The copy constructor creates a Definition object that shares the underlying smart-pointer of the source Definition. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Definition in_that) |
Check if the source Definition is equivalent to this Definition. More... | |
override int | GetHashCode () |
string | Name () |
Get the name given to this Definition when it was defined. More... | |
HPS.PortfolioKey | Owner () |
Get the portfolio that owns this Definition. More... | |
void | Undefine () |
Removes this definition from the owning portfolio. More... | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
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. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Definition a, HPS.Definition b) |
static bool | operator== (HPS.Definition a, HPS.Definition b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ImageDefinition class is a smart pointer to a database object.
It is a handle to an image defined within a portolfio.
HPS.ImageDefinition.ImageDefinition | ( | ) |
The default constructor creates an uninitialized ImageDefinition object.
The Type() function will return Type::None.
HPS.ImageDefinition.ImageDefinition | ( | HPS.Definition | in_that | ) |
This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition.
The copy will only be successful if the source definition is really an upcast of an image definition. Otherwise the copy will fail and the resulting ImageDefinition will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
HPS.ImageDefinition.ImageDefinition | ( | HPS.ImageDefinition | in_that | ) |
This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition.
The copy will only be successful if the source definition is really an upcast of an image definition. Otherwise the copy will fail and the resulting ImageDefinition will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_definition" kindref="compound">Definition</ref> to copy. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Definition.
void HPS.ImageDefinition.Set | ( | HPS.ImageKit | in_kit | ) |
Redefine the image for this ImageDefinition.
in_kit | The new image for this <ref refid="class_h_p_s_1_1_image_definition" kindref="compound">ImageDefinition</ref>. |
void HPS.ImageDefinition.Show | ( | out HPS.ImageKit | out_kit | ) |
Shows the image for this ImageDefinition.
out_kit | The image for this <ref refid="class_h_p_s_1_1_image_definition" kindref="compound">ImageDefinition</ref>. |