CHSDK Class Descriptions › CaWVersionChooser

CaWVersionChooser

CaWVersionChooser cannot be instantiated directly. The CaWVersionChooser object can only be retrieved from the CaWContext after the project and state have been correctly added to the context.

The Version Chooser provides a mechanism to select a set of versions based upon filtered criteria. Each Version Chooser attribute adds an additional restriction on the selected version set. The resulting version list is available to CaWDeleteVersion, CaWCheckin and CaWCheckout processes in the current context. A list of attributes from the selected versions can be retrieved in the form of a CaWContainer.

Usage

• Set the Project and State Context.

  Note: If the State is a Snapshot State then set a Snapshot View in the current context. If the State is not a Snapshot State and there is no Working View then the Version Chooser is not active.

• Set the desired Version Chooser attributes.
• Invoke the Execute function.

Properties

• ParentPath
• ItemName
• Recursive
• BranchOption
• VersionOption
• VersionItemOption
• VersionStatusOption
• VersionDateOption
• FromDate
• ToDate

Methods

• Clear
• SetItemObjId
• SetPackageObjId
• GetVersionList
• Execute
• IsValid

More information:

• CHSDK Programming Fundamentals
• CaWContext
• CaWContainer
• CaWCheckin
• CaWCheckout
• CaWDeleteVersion