Public Member Functions | List of all members
EachColorArg Class Referenceabstract

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

#include <PropertyContext.h>

Inheritance diagram for EachColorArg:
EachPropertyBaseArg

Public Member Functions

UInt32 GetStoredValue ()
 Get the value of the property that is stored in the element. More...
 
UInt32 GetEffectiveValue ()
 Get the effective value of the property that is used for display. More...
 
StatusInt SetStoredValue (UInt32 newVal)
 Assign a new value in place of the one passed to the callback. More...
 
- Public Member Functions inherited from EachPropertyBaseArg
PropsCallbackFlags GetPropertyFlags ()
 Flags associated with the property value. More...
 

Detailed Description

Element color information supplied to "Each" callback.

Note
Set methods ignored when using IQueryProperties.

Member Function Documentation

UInt32 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.

UInt32 GetStoredValue ( )

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

StatusInt SetStoredValue ( UInt32  newVal)

Assign a new value 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.