The PortfolioControl class is a smart pointer that is tied to a database object.
More...
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
HandleRef | scptr |
|
The PortfolioControl class is a smart pointer that is tied to a database object.
Controls are used for manipulating settings within the database.
Initializes a control tied to the segment in_seg.
Initializes a control tied to the same object as in_that.
ulong HPS.PortfolioControl.GetCount |
( |
| ) |
|
Returns the number of portfolios in use here.
override HPS.Type HPS.PortfolioControl.ObjectType |
( |
| ) |
|
|
virtual |
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.
bool HPS.PortfolioControl.Pop |
( |
| ) |
|
Removes the top portfolio from the portfolio use stack.
- Returns
- true if a portfolio was present, false otherwise.
Removes the top portfolio from the portfolio use stack and gives information about it to the user.
- Parameters
-
out_portfolio | The source portfolio. |
- Returns
- true if a portfolio was present, false otherwise.
Adds a portfolio to the top of the portfolio use stack.
Existing portfolios in use are unmodified but portfolios on top take precedence if there are conflicting definitions.
- Parameters
-
in_portfolio | The portfolio to push to the top of the portfolio use stack. |
- Returns
- A reference to this object.
Sets a portfolio as the only portfolio in use, replacing any existing portfolios in use.
- Parameters
-
in_portfolio | A portfolio containing definitions that should be imported. |
- Returns
- A reference to this object.
Sets a collection of portfolios as the only portfolios in use, replacing any existing portfolios in use.
- Parameters
-
in_portfolios | An array of source portfolios to be used. |
- Returns
- A reference to this object.
Shows all portfolios in use on this segment.
- Parameters
-
out_portfolios | Keys to all portfolios in use on this segment. |
- Returns
- true if any portfolio was present, false otherwise.
Shows the top portfolio on the portfolio use stack.
- Parameters
-
out_portfolio | The portfolio on top of the stack. |
- Returns
- true if a portfolio was present, false otherwise.
Removes all portfolios from the portfolio use stack.
- Returns
- A reference to this object.
Removes the top portfolio from the portfolio use stack.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: