Public Member Functions | List of all members
EachLineStyleArg Class Referenceabstract

Element linestyle information supplied to "Each" callback. More...

#include <PropertyContext.h>

Inheritance diagram for EachLineStyleArg:
EachPropertyBaseArg

Public Member Functions

Int32 GetStoredValue ()
 Get the value of the property that is stored in the element. More...
 
Int32 GetEffectiveValue ()
 Get the effective value of the property that is used for display. More...
 
LineStyleParams const * GetParams ()
 For this linestyle value stored on the element, get the corresponding stored line style parameters. More...
 
bool GetEffectiveParams (LineStyleParams &)
 For this linestyle value stored on the element, get the resolved parameters taking into account level. More...
 
bool GetParamsChanged ()
 Get the value of the flag stating whether the parameters have been changed. More...
 
StatusInt SetStoredValue (Int32 newVal)
 Assign a linestyle in place of the one passed to the callback. More...
 
StatusInt SetParams (LineStyleParams const *newParams)
 Change the linestyle params. More...
 
StatusInt SetParamsChanged ()
 Explicitly force the parameters to be rewritten by marking them as changed. Normally this is done automatically by the system when changing linestyle parameters. More...
 
- Public Member Functions inherited from EachPropertyBaseArg
PropsCallbackFlags GetPropertyFlags ()
 Flags associated with the property value. More...
 

Detailed Description

Element linestyle information supplied to "Each" callback.

Note
Set methods ignored when using IQueryProperties.

Member Function Documentation

bool GetEffectiveParams ( LineStyleParams )

For this linestyle value stored on the element, get the resolved parameters taking into account level.

Int32 GetEffectiveValue ( )

Get the effective value of the property that is used for display.

This is computed from the stored value considering header overrides. If the stored value is BYCELL or BYLEVEL, the effective value will resolve the value from the cell or level respectively.

LineStyleParams const* GetParams ( )

For this linestyle value stored on the element, get the corresponding stored line style parameters.

bool GetParamsChanged ( )

Get the value of the flag stating whether the parameters have been changed.

Int32 GetStoredValue ( )

Get the value of the property that is stored in the element.

StatusInt SetParams ( LineStyleParams const *  newParams)

Change the linestyle params.

If NULL is passed in, then the ACTIVE linestyle params are used. NOTE: You must set the line style using SetStoredValue() before setting the parameters.

StatusInt SetParamsChanged ( )

Explicitly force the parameters to be rewritten by marking them as changed. Normally this is done automatically by the system when changing linestyle parameters.

StatusInt SetStoredValue ( Int32  newVal)

Assign a linestyle in place of the one passed to the callback.


The documentation for this class was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.