company logo

Property :: dirty - Is property handle dirty

The property returns, whether the selection or instance in a property handle has been changed. This happens in client/server mode, when the selection or instance in a property handle on the server side differs from the selection or instance on the client side.

Usually, the client automatically submits a refresh, when the instance is dirty after a client server action, e.g. after executing an action. The application can avoid refreshing the instance by resetting the dirty flag ( isDirty( false ) ).

The property throws an exception, when the property handle is not valid.

Return value:  Dirty state ( bool  )

The option indicates, whether an object is to be set to dirty ( true ) or not ( false ).

Implementation overview

Implementation details

  1. Get dirty flag
    bool Property  :: dirty (  )

    The function returns the current state of the dirty flag. When being set, the client should refresh the instance selection in the property handle as soon as possible, e.g. when calling the next client/server function.

    2. to list
  2. Set dirty flag
    bool Property  :: dirty ( bool bDirty )

    When setting ( true ) or resetting ( false ) the dirty flag for the the property handle, the information is passed to the client, when being set on the server side in a client/server environment (e.g. in a context function when executing an instance or property action).

    • bDirty - Dirty state

      The option indicates, whether an object is to be set to dirty ( true ) or not ( false ).

    3. to list
to top previous next upper table of contents Comment