The BCWorkPackage type exposes the following members.

Methods

  NameDescription
Public methodAddDocument
Assigns a document to the work area.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodDocuments()()()()
Returns the collection of documents assigned to the work area. The collection is sorted ascending on the DisplayName property value.
Public methodDocuments(BCCollectionBase<(Of <<'(BCPropertyDef>)>>))
Returns the collection of documents assigned to the work area. The collection is sorted ascending on the DisplayName property value.
Public methodDocuments(BCCollectionBase<(Of <<'(BCPropertyDef>)>>), SortKind)
Returns the collection of documents assigned to the work area.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecuteTransition(BCWorkPackageTransition)
Moves the work area to another state.
Public methodExecuteTransition(BCWorkPackageTransition, BCBaseline%, BCBaseline%)
Moves the work area to another state.
Public methodExecuteTransition(BCWorkPackageTransition, BCBaseline%, BCBaseline%, Boolean)
Moves the work area to another state.
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBaseline
Returns a baselines with the specified ID property value created in the work area.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetSelection
Returns a selection with the specified ID property value.
Public methodGetSequence
Returns a sequence with the specified name. If the sequence does not exist, creates it.
(Inherited from BCRepositoryObject.)
Public methodGetSequenceList
Returns an array of all available sequences.
(Inherited from BCRepositoryObject.)
Public methodGetSubWorkPackage
Returns a sub-work area with the specified ID property value.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWorkList
Returns a work list in the work area with the specified ID property value.
Public methodLoadProperties
Returns a property collection for a property set with the specified name.
(Inherited from BCRepositoryObject.)
Public methodMakeSelection
Returns a new selection object from the given collection of documents.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewBaseline
Creates a new baseline.
Public methodNewSelection
Creates a new selection.
Public methodNewSubWorkPackage
Creates a new sub-work area.
Protected methodOnDispose
The method is called on the Dispose()()()() method call. Derived classes should override the method to perform custom disposing.
(Inherited from DisposableObject.)
Public methodReleaseDocument(BCDocument)
Releases a document to the parent area with no reassignment.
Public methodReleaseDocument(BCDocument, Boolean)
Releases a document to the parent area.
Public methodRemoveDocument(BCDocument)
Discards/revokes a document from the work area with no reassignment.
Public methodRemoveDocument(BCDocument, Boolean)
Discards/revokes a document from the work area.
Public methodRemoveSubWorkPackage
Removes the given sub-work area.
Public methodSaveProperties
Saves a property collection.
(Inherited from BCRepositoryObject.)
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  NameDescription
Public propertyAccessRights
Gets access rights of the work area.
Public propertyBaselines
Gets the collection of baselines created in the work area.
Public propertyColumnPropertyDefCollection
Gets the collection of the properties that are shown as columns in "All Documents in the work area" view.
Public propertyCreatedFrom
Gets the template that the work area was created from. Returns nullNothingnullptra null reference (Nothing in Visual Basic) for the Main area.
Public propertyCreationDate
Gets the date the work area was created.
Public propertyCurrentState
Gets the current transition state of the work area.
Public propertyDisplayName
Gets or sets the display name of the work area.
Public propertyEnclosure
Gets the enclosure that manages access to dependent objects.
Public propertyExtendable
Gets the extended object.
(Inherited from BCRepositoryObject.)
Public propertyID
Gets the value that uniquely identifies the work area.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyMaintainHistory
Gets or sets a value indicating whether a history is kept during the lifetime of the work area.
Public propertyName
Gets the internal name of the work area.
Public propertyOnImportDocument
Gets or sets the state to set when a document is imported.
Public propertyParentWorkPackage
Gets the parent work area. Returns nullNothingnullptra null reference (Nothing in Visual Basic) for main area.
Public propertyPath
Gets the context path of the work area. Lists all parent work areas separated by backslashes (\).
Public propertyRepository
Gets the repository to which the object belongs.
(Inherited from BCRepositoryObject.)
Public propertyRetainHistory
Gets a value indicating whether the full history is retained after the work area has become inactive.
Public propertySecurable
Gets the secured object.
(Inherited from BCRepositoryObject.)
Public propertySelections
Gets the collection of selections in the current work area.
Public propertySubWorkPackages
Gets the collection of sub-work areas in the work area.
Public propertyTemplate
Gets the template used to create the work package.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyWorkIsolationMode
Gets or sets a value indicating whether Work Isolation mode has been enabled for the work area.
Public propertyWorkLists
Gets the collection of work lists in the work area.

See Also