The BCEnvironment type exposes the following members.

Methods

  NameDescription
Public methodApplyTmpFieldPathDefinition
Applies the temporary definition of the Field-Path definition facility.
Public methodCopyDocumentTypePrivileges
Copies privileges from the specified source document type to all destination document types, for each user role.
Public methodCreateFieldPathDefinition
Creates the definition of the Field-Path definition facility.
Public methodCreateTmpFieldPathDefinition
Creates the temporary definition of the Field-Path definition facility.
Public methodDeleteTmpFieldPathDefinition
Deletes the temporary definition of the Field-Path definition facility.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
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 methodGetCreatableDocumentTypes(String, String, String)
Returns a collection of document types that can be created with privileges of the specified enclosure.
Public methodGetCreatableDocumentTypes(String, String, String, DocumentTypeFlags)
Returns a collection of document types that can be created with privileges of the specified enclosure.
Public methodGetDocRefType
Returns a document reference type with the specified ID property value.
Public methodGetDocumentType
Returns a document type with the specified ID property value.
Public methodGetExtensionMapping
Returns an extension mapping with the specified ID property value.
Public methodGetFieldPathDefinition
Returns a Field-Path definition object in which the given property participates.
Public methodGetFieldPathLevel
Returns a Field-Path level object to which the given property is associated.
Public methodGetFolderType
Returns a folder type with the specified ID property value.
Public methodGetGlobalSearchQuery
Returns a global search query with the specified ID property value.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLookupListWithID
Returns a lookup list with the specified ID property value.
Public methodGetLookupListWithName
Returns a lookup list with the specified name.
Public methodGetMappedDocumentTypes
Returns the collection of all document types that are mapped to the specified extension.
Public methodGetModificationDate Obsolete.
Returns the date when the environment was last modified.
Public methodGetNavigationView
Returns a navigation view with the specified ID property value.
Public methodGetPrivilegeWithName
Returns a privilege with the specified name.
Public methodGetProjectDefinition
Returns a project definition with the specified ID property value.
Public methodGetPropertySet
Returns a property set with the specified ID property value.
Public methodGetReport
Returns a report 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 methodGetStoredPropertyDefCollection
Returns a stored collection of property definitions with the specified ID property value.
Public methodGetStoredSearchQuery
Returns a stored search query with the specified ID property value.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUIExtensionRef
Returns a definition of a UI extension with the specified ID property value.
Public methodGetUIExtensionRefsWithTypeID
Returns the collection of UI extension definitions with the specified TypeID.
Public methodGetUserRoleWithName
Returns a user role with the specified name.
Public methodGetWorkflowDefinition
Returns a workflow definition with the specified ID property value.
Public methodGetWorkPackageTemplate
Returns a work area template with the specified ID property value.
Public methodLoadProperties
Returns a property collection for a property set with the specified name.
(Inherited from BCRepositoryObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewDocRefType()()()()
Creates a new document reference type.
Public methodNewDocRefType(String)
Creates a new document reference type with the specified name.
Public methodNewDocumentType()()()()
Creates a new document type.
Public methodNewDocumentType(String)
Creates a new document type with the specified name.
Public methodNewExtensionMapping()()()()
Creates a new extension mapping.
Public methodNewExtensionMapping(String)
Creates a new extension mapping with the specified name.
Public methodNewFolderType()()()()
Creates a new folder type with the specified name.
Public methodNewFolderType(String)
Creates a new folder type with the specified name.
Public methodNewGlobalSearchQuery()()()()
Creates a new global search query.
Public methodNewGlobalSearchQuery(String)
Creates a new global search query with the specified name.
Public methodNewLookupList()()()()
Creates a new lookup list.
Public methodNewLookupList(String)
Creates a new lookup list with the specified name.
Public methodNewNavigationView()()()()
Creates a new navigation view.
Public methodNewNavigationView(String)
Creates a new navigation view with the specified name.
Public methodNewPrivilege
Creates a privilege with the specified name.
Public methodNewProjectDefinition()()()()
Creates a new project definition.
Public methodNewProjectDefinition(String)
Creates a new project definition with the specified name.
Public methodNewPropertySet()()()()
Creates a new set of properties.
Public methodNewPropertySet(String)
Creates a new set of properties with the specified name.
Public methodNewReport()()()()
Creates a new report.
Public methodNewReport(String)
Creates a new report with the specified name.
Public methodNewStoredPropertyDefCollection()()()()
Creates a new stored collection of property definitions.
Public methodNewStoredPropertyDefCollection(String)
Creates a new stored collection of property definitions with the specified name.
Public methodNewStoredSearchQuery()()()()
Creates a new stored search query.
Public methodNewStoredSearchQuery(String)
Creates a new stored search query with the specified name.
Public methodNewUIExtensionRef()()()()
Creates a new UI extension definition.
Public methodNewUIExtensionRef(String)
Creates a new UI extension definition with the specified name.
Public methodNewUserRole
Creates a user role with the specified name.
Public methodNewWorkflowDefinition()()()()
Creates a new workflow definition.
Public methodNewWorkflowDefinition(String)
Creates a new workflow definition with the specified name.
Public methodNewWorkPackageTemplate()()()()
Creates a new work area template.
Public methodNewWorkPackageTemplate(String)
Creates a new work area template with the specified name.
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 methodSaveProperties
Saves a property collection.
(Inherited from BCRepositoryObject.)
Public methodSetUserRolePrivileges
Sets or removes specified privileges on the specified user role in one call.
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.)
Public methodUpdateModificationDate
Updates the modification date of the environment.

Properties

  NameDescription
Public propertyAllDocumentProperties
Gets the collection of property definitions used for all document types.
Public propertyAllFolderProperties
Gets the collection of property definitions used for all folder types.
Public propertyAllowedInFieldPathProperties
Returns the collection of property definitions that may be used in a Field-Path Definition.
Public propertyAllUnassignedProperties
Gets the collection of all property definitions of all unassigned property definitions.
Public propertyAvailableNavigationViews
Gets the collection of navigation views that are available to the user.
Public propertyAvailableToDoPersonAdditionalPrivileges
Gets the collection of privileges that are available as additional to-do person privileges in a workflow state.
Public propertyCustomToDoPersonAdditionalPrivileges
Gets the collection of custom privileges that are available as additional to-do person privileges in a workflow state.
Public propertyDefaultDocumentType
Gets or sets the default document type.
Public propertyDefaultStoredPropertyDefCollection
Gets or sets the default stored collection of property definitions.
Public propertyDisplayName
Gets or sets the display name of the environment.
Public propertyDocRefTypes
Gets the collection of all document reference types.
Public propertyDocumentTypes
Gets the collection of all document types.
Public propertyExtendable
Gets the extended object.
(Inherited from BCRepositoryObject.)
Public propertyExtensionMappings
Gets the collection of all extension mappings.
Public propertyFieldPathDefinition
Gets the definition of the Field-Path definition facility, or null if the Field-Path definition is not defined.
Public propertyFolderTypes
Gets the collection of all folder types.
Public propertyGlobalSearchQueries
Gets the collection of all global search queries.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyLastChanged
Gets the date on which the environment was last changed.
Public propertyLookupLists
Gets the collection of all lookup lists.
Public propertyModificationDate
Gets the date when the environment was last modified.
Public propertyName
Gets the internal name of the environment.
Public propertyNavigationViews
Gets the collection of navigation views.
Public propertyPreferredForSearchPropertyDefCollection
Gets the collection of property definitions preferred for search.
Public propertyPrivileges
Gets the collection of all privileges.
Public propertyProjectDefinitions
Gets the collection of all project definitions.
Public propertyPropertySets
Gets the collection of all property sets.
Public propertyReports
Gets the collection of all reports.
Public propertyRepository
Gets the repository to which the object belongs.
(Inherited from BCRepositoryObject.)
Public propertyRequiredChangePrivilege
Gets or sets the privilege required to change the privileges.
Public propertySearchPropertyDefCollection
Gets the collection of property definitions for search results.
Public propertySecurable
Gets the secured object.
(Inherited from BCRepositoryObject.)
Public propertyStoredPropertyDefCollections
Gets the collection of all stored collections of property definitions.
Public propertyStoredSearchQueries
Gets the collection of all stored search queries.
Public propertyTmpFieldPathDefinition
Gets the temporary definition of the Field-Path definition facility, or null if the Field-Path definition is not defined.
Public propertyUIExtensionRefs
Gets the collection of all UI extension definitions.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Public propertyUseDTSecurity
Gets or sets a value indicating whether document type security (DTS) is used.
Public propertyUseRoleBasedSecurity
Gets or sets a value indicating whether role-based security is used.
Public propertyUserPropertyDefCollection
Gets the stored collection of property definitions for the current user.
Public propertyUserRoles
Gets the collection of all user roles.
Public propertyVersionNumber
Gets the version number of the environment.
Public propertyWorkflowDefinitions
Gets the collection of all workflow definitions.
Public propertyWorkListColumnPropertyDefCollection
Gets the collection of property definitions for columns in the documents view of work lists.
Public propertyWorkPackageTemplates
Gets the collection of all work area templates.

See Also