DisplayRule is an item in DisplayRuleSet that represents a single rule. More...
#include <DisplayRules.h>
Public Member Functions | |
| bool | Equals (DisplayRuleCR displayRule) const |
| Returns true if this and give DisplayRule are equal. More... | |
| bool | IsEnabled () const |
| Identifies whether DisplayRule is enabled. More... | |
| void | SetIsEnabled (bool enabled) |
| Sets IsEnabled flag to given value. More... | |
| bool | StopIfTrue () const |
| Returns true if rule processing should stop then this rule is met. More... | |
| void | SetStopIfTrue (bool stopIfTrue) |
| Sets StopIfTrue value that controls whether rule processing should stop then this rule is met. More... | |
| WStringCR | GetCondition () const |
| Returns ECExpression string condition. More... | |
| void | SetCondition (WStringCR condition) |
| Sets given ECExpression string condition. More... | |
| WStringCR | GetConditionDescription () const |
| Returns ECExpression string condition description. More... | |
| void | SetConditionDescription (WStringCR conditionDescription) |
| Sets given ECExpression string condition description. More... | |
| DisplayRuleActionPtrVector & | GetActions () |
| Returns actions associated with this DisplayRule. More... | |
| DisplayRulePtr | Clone (DgnFileR dgnFile) const |
| Creates exact copy of an instance. More... | |
 Public Member Functions inherited from RefCounted< IRefCounted > | |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
| UInt32 | AddRef () const |
| UInt32 | Release () const |
| RefCounted () | |
| RefCounted (RefCounted const &rhs) | |
| RefCounted & | operator= (RefCounted const &rhs) |
| UInt32 | GetRefCount () const |
Static Public Member Functions | |
| static DisplayRulePtr | Create (WStringCR condition, bool stopIfTrue, DgnFileR dgnFile) |
| Creates an instance of DisplayRule. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from RefCounted< IRefCounted > | |
| virtual | ~RefCounted () |
| Protected Member Functions inherited from IRefCounted | |
| virtual | ~IRefCounted () |
| void * | operator new (size_t size) |
| void | operator delete (void *rawMemory, size_t size) |
Detailed Description
DisplayRule is an item in DisplayRuleSet that represents a single rule.
It defines a condition and list of actions that should be applied to the elements when condition is met.
Condition
DisplayRule condition is based on ECExpressions. It is a string based script that is parsed and evaluated by DisplayRules. Condition supports simple property value comparison as well as complicated conditions with AND and OR operators, grouping and property to property comparisons.
Conditions can access properties comming from different hosts:
- ELEMENT - element properties or item properties associated to that element.
- MODEL - model element is in properties or item properties associated to that model.
- REFERENCE - reference element is in properties or item properties associated to that reference.
- FILE - file element is in properties or item properties associated to that file.
- VIEW - view that is drawn properties or item properties associated to that view.
Condition format and types:
- Property comparison to some value (format and example): HostName.SchemaName::ClassName::Propertyname OPERATOR VALUE "element.DgnElementSchema::ShapeElement::EnclosedArea>2000000000"
- Object type check (format and example): HostName.IsOfClass ("ClassName","SchemaName") "element.IsOfClass ("ShapeElement","DgnElementSchema")"
- Property to propery comparison - usefull for defining a threashold and comparing to it (format and example): HostName.SchemaName::ClassName::PropertyName OPERATOR HostName.SchemaName::ClassName::PropertyName "element.DgnElementSchema::ShapeElement::EnclosedArea>model.DgnCustomItemsSchema::Threasholds::TooBigArea"
- Complex expression (format and example): HostName.SchemaName::ClassName::PropertyName OPERATOR Value AND (HostName.SchemaName::ClassName::PropertyName OPERATOR VALUE OR HostName.SchemaName::ClassName::PropertyName OPERATOR VALUE) "element.DgnElementSchema::ShapeElement::EnclosedArea>20000000 AND (element.Facilities::Room::Occupied=true OR element.IsOfClass ("Corridor","Facilities"))"
Note:
- Conditions should specify only stored values, not the values displayed to the user. However, some properties requires global value representation to be used. For example - Level property is a level ID that might be different depending on a model, so level name is its global representation. To get global representation please use IDgnECTypeAdapter associated to the property.
- Conditions should specify ECSchema/ECClass/ECProperty names and not DisplayLabels.
- DisplayRules ConditionEditor dialog can be used to create ECExpression strings that later can be used in the code. This will ensure valid ECExpressions.
Actions
DisplayRules actions specifies how element representation should be changed. Singe rule can specify multiple actions, but only one of the same type should exist in the list.
- See also
- DisplayRuleSet for set of display rules.
- DisplayRulesManager for more details how to manage DisplayRuleSets in the file.
- Remarks
- Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib
Member Function Documentation
| DisplayRulePtr Clone | ( | DgnFileR | dgnFile | ) | const |
Creates exact copy of an instance.
|
static |
Creates an instance of DisplayRule.
- Parameters
-
[in] condition ECExpression string condition. [in] stopIfTrue rule processing will stop if condition is met and this flag is set to true. [in] dgnFile DgnFile that is associated with the rule.
- Returns
- DisplayRule instance ref counted pointer.
| bool Equals | ( | DisplayRuleCR | displayRule | ) | const |
Returns true if this and give DisplayRule are equal.
| DisplayRuleActionPtrVector& GetActions | ( | ) |
Returns actions associated with this DisplayRule.
- See also
- IDisplayRuleAction for more details.
| WStringCR GetCondition | ( | ) | const |
Returns ECExpression string condition.
| WStringCR GetConditionDescription | ( | ) | const |
Returns ECExpression string condition description.
| bool IsEnabled | ( | ) | const |
Identifies whether DisplayRule is enabled.
- Returns
- true if DisplayRule is enabled.
| void SetCondition | ( | WStringCR | condition | ) |
Sets given ECExpression string condition.
| void SetConditionDescription | ( | WStringCR | conditionDescription | ) |
Sets given ECExpression string condition description.
| void SetIsEnabled | ( | bool | enabled | ) |
Sets IsEnabled flag to given value.
| void SetStopIfTrue | ( | bool | stopIfTrue | ) |
Sets StopIfTrue value that controls whether rule processing should stop then this rule is met.
| bool StopIfTrue | ( | ) | const |
Returns true if rule processing should stop then this rule is met.
The documentation for this struct was generated from the following file: