Inheritance diagram for HPS.StyleControl:
HPS.Control HPS.Object

Public Member Functions

HPS.StyleKey AppendNamed (string in_style_name, HPS.ConditionalExpression in_conditional, HPS.Style.AppendMode in_mode)
 
HPS.StyleKey AppendNamed (string in_style_name, HPS.ConditionalExpression in_conditional)
 
HPS.StyleKey AppendSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional, HPS.Style.AppendMode in_mode)
 
HPS.StyleKey AppendSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)
 
override void Dispose ()
 
void Flush (HPS.SegmentKey in_style_source)
 
void Flush (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)
 
void Flush (string in_style_name)
 
void Flush (string in_style_name, HPS.ConditionalExpression in_conditional)
 
ulong GetCount ()
 
override HPS.Type ObjectType ()
 
bool Pop ()
 
bool Pop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.ConditionalExpression out_conditional)
 
HPS.StyleKey PushNamed (string in_style_name)
 
HPS.StyleKey PushNamed (string in_style_name, HPS.ConditionalExpression in_conditional)
 
HPS.StyleKey PushSegment (HPS.SegmentKey in_style_source)
 
HPS.StyleKey PushSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)
 
void Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names, HPS.ConditionalExpression[] in_conditions)
 
void Set (HPS.Style.Type[] in_types, HPS.SegmentKey[] in_segment_sources, string[] in_style_names)
 
HPS.StyleKey SetNamed (string in_style_name)
 
HPS.StyleKey SetNamed (string in_style_name, HPS.ConditionalExpression in_conditional)
 
HPS.StyleKey SetSegment (HPS.SegmentKey in_style_source)
 
HPS.StyleKey SetSegment (HPS.SegmentKey in_style_source, HPS.ConditionalExpression in_conditional)
 
bool Show (out HPS.Style.Type[] out_types, out HPS.SegmentKey[] out_segment_sources, out string[] out_style_names, out HPS.ConditionalExpression[] out_conditions)
 
bool Show (out HPS.StyleKey[] out_styles)
 
bool ShowAllNamed (out string[] out_names, out HPS.ConditionalExpression[] out_conditions)
 
bool ShowAllNamed (out HPS.StyleKey[] out_styles)
 
bool ShowAllSegment (out HPS.SegmentKey[] out_segments, out HPS.ConditionalExpression[] out_conditions)
 
bool ShowAllSegment (out HPS.StyleKey[] out_styles)
 
bool ShowTop (out HPS.Style.Type out_type, out HPS.SegmentKey out_segment_source, out string out_style_name, out HPS.ConditionalExpression out_conditional)
 
bool ShowTop (out HPS.StyleKey out_style)
 
 StyleControl (HPS.SegmentKey in_seg)
 
 StyleControl (HPS.StyleControl in_that)
 
override HPS.Type Type ()
 
void UnsetAllNamed ()
 
void UnsetAllSegment ()
 
void UnsetEverything ()
 
void UnsetTop ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database.

Constructor & Destructor Documentation

◆ StyleControl() [1/2]

HPS.StyleControl.StyleControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ StyleControl() [2/2]

HPS.StyleControl.StyleControl ( HPS.StyleControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ AppendNamed() [1/2]

HPS.StyleKey HPS.StyleControl.AppendNamed ( string  in_style_name,
HPS.ConditionalExpression  in_conditional,
HPS.Style.AppendMode  in_mode 
)
inline

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Parameters
in_style_nameThe name of the named style which should be defined in an accessible portfolio.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
in_modeThe behavior of the conditional expression if another conditional style is currently applied with the same style.
Returns
a StyleKey that can be used to interact with the style.

◆ AppendNamed() [2/2]

HPS.StyleKey HPS.StyleControl.AppendNamed ( string  in_style_name,
HPS.ConditionalExpression  in_conditional 
)
inline

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Parameters
in_style_nameThe name of the named style which should be defined in an accessible portfolio.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
Returns
a StyleKey that can be used to interact with the style.

◆ AppendSegment() [1/2]

HPS.StyleKey HPS.StyleControl.AppendSegment ( HPS.SegmentKey  in_style_source,
HPS.ConditionalExpression  in_conditional,
HPS.Style.AppendMode  in_mode 
)
inline

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Parameters
in_style_sourceThe segment to use as the source for the attributes that should be styled.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
in_modeThe behavior of the conditional expression if another conditional style is currently applied with the same style.
Returns
a StyleKey that can be used to interact with the style.

◆ AppendSegment() [2/2]

HPS.StyleKey HPS.StyleControl.AppendSegment ( HPS.SegmentKey  in_style_source,
HPS.ConditionalExpression  in_conditional 
)
inline

Appends a conditional expression to an existing style or conditional style. If the style does not currently exist, a new conditional style is pushed. Conditional styles are only applied if their condition(s) are satisfied.

Parameters
in_style_sourceThe segment to use as the source for the attributes that should be styled.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
Returns
a StyleKey that can be used to interact with the style.

◆ Flush() [1/4]

void HPS.StyleControl.Flush ( HPS.SegmentKey  in_style_source)
inline

Removes any styles on the associated segment which refer to the provided style source. The styles will be removed regardless if there is a conditional expression associated with the style or not.

Parameters
in_style_sourceThe style source used to identify which styles to remove.

◆ Flush() [2/4]

void HPS.StyleControl.Flush ( HPS.SegmentKey  in_style_source,
HPS.ConditionalExpression  in_conditional 
)
inline

Removes any styles on the associated segment which refer to the provided style source with the provided condition. If a style is found which references the style source and has an associated conditional expression which contains the provided conditional expression, the provided conditional expression will be removed from the conditional expression associated with the style. If removing the provided conditional expression from the style results in the complete removal of the conditional expression for the style, the style itself will be completely removed.

Parameters
in_style_sourceThe style source used to identify which styles to remove or modify.
in_conditionalThe conditional expression to remove from styles which refer to the provided style source.

◆ Flush() [3/4]

void HPS.StyleControl.Flush ( string  in_style_name)
inline

Removes any styles on the associated segment which refer to the provided style name. The styles will be removed regardless if there is a conditional expression associated with the style or not.

Parameters
in_style_nameThe style name used to identify which styles to remove.

◆ Flush() [4/4]

void HPS.StyleControl.Flush ( string  in_style_name,
HPS.ConditionalExpression  in_conditional 
)
inline

Removes any styles on the associated segment which refer to the provided style name with the provided condition. If a style is found which references the style name and has an associated conditional expression which contains the provided conditional expression, the provided conditional expression will be removed from the conditional expression associated with the style. If removing the provided conditional expression from the style results in the complete removal of the conditional expression for the style, the style itself will be completely removed.

Parameters
in_style_nameThe style name used to identify which styles to remove or modify.
in_conditionalThe conditional expression to remove from styles which refer to the provided style name.

◆ GetCount()

ulong HPS.StyleControl.GetCount ( )
inline

Returns the number of styles set here.

◆ ObjectType()

override HPS.Type HPS.StyleControl.ObjectType ( )
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.Control.

◆ Pop() [1/2]

bool HPS.StyleControl.Pop ( )
inline

Removes the most recent style.

Returns
true if a style was present, false otherwise.

◆ Pop() [2/2]

bool HPS.StyleControl.Pop ( out HPS.Style.Type  out_type,
out HPS.SegmentKey  out_segment_source,
out string  out_style_name,
out HPS.ConditionalExpression  out_conditional 
)
inline

Removes the most recent style and gives information about it to the user.

Parameters
out_typeIndicates the type of the style.
out_segment_sourceIf out_type was Segment, this value contains the source segment for the style.
out_style_nameIf out_type was Named, this value contains the name of the style (defined in a portfolio).
out_conditionalThe conditions, if any, set on the style when it was applied.
Returns
true if a style was present, false otherwise.

◆ PushNamed() [1/2]

HPS.StyleKey HPS.StyleControl.PushNamed ( string  in_style_name)
inline

Adds a named style to the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

◆ PushNamed() [2/2]

HPS.StyleKey HPS.StyleControl.PushNamed ( string  in_style_name,
HPS.ConditionalExpression  in_conditional 
)
inline

Adds a conditional named style to the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings. Conditional styles are only applied if their condition(s) are satisfied.

Parameters
in_style_nameThe name of the named style which should be defined in an accessible portfolio.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
Returns
a StyleKey that can be used to interact with the style.

◆ PushSegment() [1/2]

HPS.StyleKey HPS.StyleControl.PushSegment ( HPS.SegmentKey  in_style_source)
inline

Creates a new style based on in_style_source and places it on the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

Parameters
in_style_sourceThe segment to use as the source for the attributes that should be styled.
Returns
a StyleKey that can be used to interact with the style.

◆ PushSegment() [2/2]

HPS.StyleKey HPS.StyleControl.PushSegment ( HPS.SegmentKey  in_style_source,
HPS.ConditionalExpression  in_conditional 
)
inline

Creates a new style based on in_style_source and places it on the top of the style stack. Existing styles are unmodified but styles on top take precedence if there are duplicate settings.

Parameters
in_style_sourceThe segment to use as the source for the attributes that should be styled.
in_conditionalA conditional expression that must be satisfied in order for the style to be applied.
Returns
a StyleKey that can be used to interact with the style.

◆ Set() [1/2]

void HPS.StyleControl.Set ( HPS.Style.Type []  in_types,
HPS.SegmentKey []  in_segment_sources,
string []  in_style_names,
HPS.ConditionalExpression []  in_conditions 
)
inline

Sets a collection of styles, replacing any existing styles.

Parameters
in_typesIndicates the type of each style.
in_segment_sourcesFor each entry, if in_type was Segment, this value must contain the source segment for the style.
in_style_namesFor each entry, if in_type was Named, this value must contain the name of the style (defined in a portfolio).
in_conditionsThe conditions to set on each style.

◆ Set() [2/2]

void HPS.StyleControl.Set ( HPS.Style.Type []  in_types,
HPS.SegmentKey []  in_segment_sources,
string []  in_style_names 
)
inline

Sets a collection of styles, replacing any existing styles.

Parameters
in_typesIndicates the type of each style.
in_segment_sourcesFor each entry, if in_type was Segment, this value must contain the source segment for the style.
in_style_namesFor each entry, if in_type was Named, this value must contain the name of the style (defined in a portfolio).

◆ SetNamed() [1/2]

HPS.StyleKey HPS.StyleControl.SetNamed ( string  in_style_name)
inline

Sets in_style_name as the only active style, replacing any existing styles.

Parameters
in_style_nameThe name of the style to apply. If the name does not exist in the active portfolio, no style is applied.

◆ SetNamed() [2/2]

HPS.StyleKey HPS.StyleControl.SetNamed ( string  in_style_name,
HPS.ConditionalExpression  in_conditional 
)
inline

Sets in_style_name as the only active style, replacing any existing styles.

Parameters
in_style_nameThe name of the style to apply. If the name does not exist in the active portfolio, no style is applied.
in_conditionalA condition or conditions that must be met for a style to be activated.

◆ SetSegment() [1/2]

HPS.StyleKey HPS.StyleControl.SetSegment ( HPS.SegmentKey  in_style_source)
inline

Sets in_style_source as the only active style, replacing any existing styles.

Parameters
in_style_sourceA segment containing attributes that should be styled.

◆ SetSegment() [2/2]

HPS.StyleKey HPS.StyleControl.SetSegment ( HPS.SegmentKey  in_style_source,
HPS.ConditionalExpression  in_conditional 
)
inline

Sets in_style_source as the only active style, replacing any existing styles.

Parameters
in_style_sourceA segment containing attributes that should be styled.
in_conditionalA condition or conditions that must be met for a style to be activated.

◆ Show() [1/2]

bool HPS.StyleControl.Show ( out HPS.Style.Type []  out_types,
out HPS.SegmentKey []  out_segment_sources,
out string []  out_style_names,
out HPS.ConditionalExpression []  out_conditions 
)
inline

Shows all styles on this segment.

Parameters
out_typesIndicates the type of each style.
out_segment_sourcesFor each entry, if out_type was Style.Type.Segment, this value contains the source segment for the style.
out_style_namesFor each entry, if out_type was Style.Type.Named, this value contains the name of the style (defined in a portfolio).
out_conditionsThe conditions, if any, set on each style when it was applied.
Returns
true if any style was present, false otherwise.

◆ Show() [2/2]

bool HPS.StyleControl.Show ( out HPS.StyleKey []  out_styles)
inline

Shows the all styles on this segment.

Parameters
out_stylesThe StyleKey for each style on this segment.
Returns
true if any style was present, false otherwise.

◆ ShowAllNamed() [1/2]

bool HPS.StyleControl.ShowAllNamed ( out string []  out_names,
out HPS.ConditionalExpression []  out_conditions 
)
inline

Shows all named styles on this segment.

Parameters
out_namesNames of all named styles set on this segment.
out_conditionsThe conditions, if any, set on each style when it was applied.
Returns
true if any style of the correct type was present, false otherwise.

◆ ShowAllNamed() [2/2]

bool HPS.StyleControl.ShowAllNamed ( out HPS.StyleKey []  out_styles)
inline

Shows the all named styles on this segment.

Parameters
out_stylesThe StyleKey for each named style on this segment.
Returns
true if any named style was present, false otherwise.

◆ ShowAllSegment() [1/2]

bool HPS.StyleControl.ShowAllSegment ( out HPS.SegmentKey []  out_segments,
out HPS.ConditionalExpression []  out_conditions 
)
inline

Shows all segment styles on this segment.

Parameters
out_segmentsKeys to all segments styled onto this segment.
out_conditionsThe conditions, if any, set on each style when it was applied.
Returns
true if any style of the correct type was present, false otherwise.

◆ ShowAllSegment() [2/2]

bool HPS.StyleControl.ShowAllSegment ( out HPS.StyleKey []  out_styles)
inline

Shows the all segment styles on this segment.

Parameters
out_stylesThe StyleKey for each segment style on this segment.
Returns
true if any segment style was present, false otherwise.

◆ ShowTop() [1/2]

bool HPS.StyleControl.ShowTop ( out HPS.Style.Type  out_type,
out HPS.SegmentKey  out_segment_source,
out string  out_style_name,
out HPS.ConditionalExpression  out_conditional 
)
inline

Shows the most recent style applied to this segment.

Parameters
out_typeIndicates the type of the style.
out_segment_sourceIf out_type was Style.Type.Segment, this value contains the source segment for the style.
out_style_nameIf out_type was Style.Type.Named, this value contains the name of the style (defined in a portfolio).
out_conditionalThe conditions, if any, set on the style when it was applied.
Returns
true if a style was present, false otherwise.

◆ ShowTop() [2/2]

bool HPS.StyleControl.ShowTop ( out HPS.StyleKey  out_style)
inline

Shows the most recent style applied to this segment.

Parameters
out_styleThe StyleKey for the most recent style applied to this segment.
Returns
true if a style was present, false otherwise.

◆ Type()

override HPS.Type HPS.StyleControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetAllNamed()

void HPS.StyleControl.UnsetAllNamed ( )
inline

Unsets all named styles on this segment.

◆ UnsetAllSegment()

void HPS.StyleControl.UnsetAllSegment ( )
inline

Unsets all segment styles on this segment.

◆ UnsetEverything()

void HPS.StyleControl.UnsetEverything ( )
inline

Unsets all styles on this segment.

◆ UnsetTop()

void HPS.StyleControl.UnsetTop ( )
inline

Unsets the most recent style on this segment.


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