Click or drag to resize
CMS.DocumentEngine Namespace
 
Classes
  ClassDescription
Public classAclInfo
AclInfo data container class.
Public classAclInfoProvider
ACL management provider.
Public classAclItemInfo
AclItemInfo data container class.
Public classAclItemInfoProvider
Class providing AclItemInfo management.
Public classAllowedChildClassInfo
AllowedChildClass data container class.
Public classAllowedChildClassInfoProvider
Class providing AllowedChildClassInfo management.
Public classAlternativeUrlCollisionData
Encapsulates data of colliding path for an alternative URL.
Public classAlternativeUrlInfo
Data container class for AlternativeUrlInfo.
Public classAlternativeUrlInfoProvider
Class providing AlternativeUrlInfo management.
Public classAlternativeUrlValidatorTask
Provides a scheduled task that validates alternative URLs against site settings (Excluded alternative URLs), checks conflicts between page URLs and alternative URLs and logs detected issues to event log.
Public classAttachmentBinaryHelper
Helper for getting and managing attachment binary data
Public classAttachmentExtensions
Extension methods for AttachmentInfo.
Public classAttachmentHistoryExtensions
Extension methods for AttachmentHistoryInfo.
Public classAttachmentHistoryInfo
AttachmentHistory data container class.
Public classAttachmentHistoryInfoProvider
Class providing attachment history management.
Public classAttachmentInfo
Attachment info data container class.
Public classAttachmentInfoProvider
Class providing attachment management.
Public classAttachmentInfoProviderExtensions
Contains extension methods for IAttachmentHistoryInfoProvider.
Public classAttachmentSource
Wrapper class to provide source attachment data
Public classAttachmentURLProvider
URL provider for the attachments.
Public classAttachmentVariantContext
Image context for attachment image.
Public classAttachmentVariantContextScope
Simplifies checking attachment variant context.
Public classBaseDocumentAction
Class for base document action
Public classBaseDocumentSettings
Container for shared settings used by operations with documents.
Public classBaseLogDocumentChangeSettings
Base class for log document change.
Public classClearDocumentFieldsTypeInfosWebFarmTask
Web farm task used to clear document field type infos.
Public classClearDocumentTypeInfosWebFarmTask
Web farm task used to clear document type infos.
Public classClearResolvedClassNamesWebFarmTask
Web farm task used to clear resolved class names.
Public classCMSDataContext
Data context.
Public classCMSDataContextBaseParentType
Data context base
Public classCMSOutputAttachment
Represents AttachmentInfo object used for response output.
Public classCMSSiteDataContext
Data context for specific site, contains only site related items
Public classCombinedDocumentAttachmentCollection
Combined collection of attachments.
Public classCombinedTreeNodeCollection
Combined collection of documents.
Public classContentMethods
Content methods - wrapping methods for macro resolver.
Public classContentPublisher
Provides an ITask interface for the content publishing.
Public classContentTransformationFunctions
Functions for content macro methods.
Public classCopyDocumentAction
Class for document copy action
Public classCopyDocumentSettings
Container for settings used when copying document.
Public classCopyNodeDataSettings
Represents the settings for the node data copying.
Public classCreateSearchFieldsEventArgs
Create search fields without values for whole local index event arguments.
Public classCreateSearchFieldsForPageEventArgs
Create search fields with values for specific page event arguments.
Public classCreateSearchFieldsForPageHandler
Create search fields with values for specific page handler.
Public classCreateSearchFieldsHandler
Create search fields without values for whole local index handler.
Public classDeleteAttachmentWebFarmTask
Web farm task used to delete attachments.
Public classDeleteDocumentAction
Class for document deletion action
Public classDeleteDocumentSettings
Container for settings used when deleting document.
Public classDocumentActionContext
Document action context. Ensures context for the document actions block.
Public classDocumentAttachment
Represents a document attachment regardless whether it is a current version or not.
Public classDocumentAttachmentCollection
Collection of the attachments
Public classDocumentAttachmentExtensions
Extension methods for attachment.
Public classDocumentAttachmentRepository
Repository for document attachments
Public classDocumentAuthorizationEventArgs
Document authorization event arguments
Public classDocumentAuthorizationHandler
Document authorization handler
Public classDocumentCategoryInfo
DocumentCategoryInfo data container class.
Public classDocumentCategoryInfoProvider
Class providing DocumentCategoryInfo management.
Public classDocumentCategorySearchIndexer
Indexer for document category
Public classDocumentChangeOrderEventArgs
Document change order event arguments
Public classDocumentChangeOrderEventArgsTDocument
Document change order event arguments
Public classDocumentChangeOrderHandler
Document change order handler
Public classDocumentClassNameRetriever
Retrieves page type class name from given IDataContainer data.
Public classDocumentColumnLists
Provides the lists of document columns (versioned, system, etc.)
Public classDocumentCultureNotAllowedException
Thrown when a document has a culture which is not allowed on the site.
Public classDocumentDataEventArgs
Document data event arguments
Public classDocumentDataEventHandler
Document data handler enables manipulation with document data.
Public classDocumentDependencyCacheKeysBuilder
Provides the dependency cache keys for documents.
Public classDocumentEngineModule
Represents the Document Engine module.
Public classDocumentEngineModuleMetadata
Represents the Document Engine module metadata.
Public classDocumentEventArgs
Document event arguments
Public classDocumentEvents
Document events.
Public classDocumentExport
Handles special actions during the Documents export process.
Public classDocumentFactoryNodeType
Factory that provides document objects
Public classDocumentFieldDataType
Field data types for document engine - string constants.
Public classDocumentFieldsTypeInfo
Type info for the document fields
Public classDocumentFileDeleteJob
Class designated for removal of serialized TreeNode objects from the file system.
Public classDocumentFormFieldInfoExtensions
Extension methods for document related form field.
Public classDocumentGenerator
Generator of the specific document types
Public classDocumentHandler
Document handler
Public classDocumentHelper
Class providing document management methods.
Public classDocumentHierarchyHelper
Object hierarchy manipulation methods.
Public classDocumentImportExportEvents
Document import export events
Public classDocumentImportHandler
Import export handler
Public classDocumentMarkEventArgs
Document mark event arguments.
Public classDocumentMarkHandler
Document mark handler.
Public classDocumentPropertyAction
Class for document property set action
Public classDocumentQuery
Predefined query returning given object type.
Public classDocumentQueryTDocument
Queries particular database data or defines parameters for data selection
Public classDocumentQueryBaseTQuery, TObject
Predefined query returning given document type.
Public classDocumentQueryProperties
Document specific properties for document queries
Public classDocumentSearchEventArgs
Document search event arguments
Public classDocumentSearchHandler
Document search handler
Public classDocumentSearchIndexer
Indexer for documents
Public classDocumentSecurityEventArgs
Document security event arguments
Public classDocumentSecurityEventArgsTDocument
Document security event arguments
Public classDocumentSecurityHandler
Document security handler
Public classDocumentSecurityHelper
Helper class to check the document security
Public classDocumentsExportEventArgs
Document export event arguments
Public classDocumentsExportHandler
Document export handler
Public classDocumentsImportEventArgs
Documents import event arguments
Public classDocumentsImportHandler
Documents import handler
Public classDocumentSortEventArgs
Documents sorting event arguments
Public classDocumentSortEventArgsTDocument
Document change order event arguments
Public classDocumentSortHandler
Document change order handler
Public classDocumentSynchronizationHelper
Class containing document synchronization logic.
Public classDocumentSystemColumns
System column names for document API
Public classDocumentTagInfo
DocumentTagInfo data container class.
Public classDocumentTagInfoProvider
Class providing document tag management.
Public classDocumentTypeHelper
Helper methods for document types
Public classDocumentTypeInfo
Specialized class for the document type info.
Public classDocumentTypeNotExistsException
Thrown when a non-existing document type is requested.
Public classDocumentTypeScopeClassInfo
DocumentTypeScopeClass data container class.
Public classDocumentTypeScopeClassInfoProvider
Class providing DocumentTypeScopeClass management.
Public classDocumentTypeScopeInfo
DocumentTypeScopeInfo data container class.
Public classDocumentTypeScopeInfoProvider
Class providing ScopeInfo management.
Public classDocumentTypeScopeResolvers
Resolvers used in e-mail templates and other macro visual components.
Public classDocumentURLProvider
URL provider for the documents.
Public classDocumentWorkflowAction
Base document workflow action
Public classDynamicTreeNodeTypeInfo
Type info for the tree node of specific type
Public classEditableItems
Editable items container.
Public classEmailAction
Class representing action to send e-mail
Public classInvalidAlternativeUrlException
Exception that is thrown when AlternativeUrlInfo is in conflict with another URL or constraint.
Public classInvalidateDocumentFieldsTypeInfoWebFarmTask
Web farm task used to invalidate document fields.
Public classInvalidateDocumentTypeInfoWebFarmTask
Web farm task used to invalidate document type infos.
Public classLinkDocumentAction
Class for document link action
Public classLogAction
Class for log action - for debug purposes
Public classLogDocumentChangeEventArgs
Log document change event arguments
Public classLogDocumentChangeHandler
Document handler
Public classLogDocumentChangeSettings
Class for log single document change.
Public classLogMultipleDocumentChangeSettings
Class for log multiple document change.
Public classMoveDocumentAction
Class for document move action
Public classMoveDocumentSettings
Container for settings used when moving document.
Public classMultiDocumentQuery
Multiple documents query
Public classMultiDocumentQueryBaseTQuery, TInnerQuery, TObject
Base class for multiple documents query.
Public classNewCultureDocumentSettings
Container for settings used when creating new document language version.
Public classNodeSelectionParameters
Structure to define the selection parameters for a document nodes selection
Public classNormalizedAlternativeUrl
Class represents url in normalized state used in alternative url feature.
Public classNotificationEmailsAction
Class representing action to send workflow notification e-mails.
Public classPageFormerUrlPathInfo
Data container class for PageFormerUrlPathInfo.
Public classPageFormerUrlPathInfoListingInfo
"Virtual" object for loading former page urls paths.
Public classPageFormerUrlPathInfoProvider
Class providing PageFormerUrlPathInfo management.
Public classPageResolvers
Macro resolvers for pages.
Public classPageSecurityHelper
Page security methods
Public classPageTemplateConfigurationInfo
Data container class for PageTemplateConfigurationInfo. Represents custom page template configuration for MVC sites.
Public classPageTemplateConfigurationInfoProvider
Class providing PageTemplateConfigurationInfo management.
Public classPageTypeFeaturesDocumentQueryExtensions
Encapsulates extension method for IDocumentQuery.
Public classPageUrlPathInfo
Data container class for PageUrlPathInfo.
Public classPageUrlPathInfoProvider
Class providing PageUrlPathInfo management.
Public classPresentationUrlRedirect
Ensures redirection to the live URL of page based on culture name (for example en-us) and node ID.
Public classRelationshipInfo
RelationshipInfo data container class.
Public classRelationshipInfoProvider
Class providing RelationshipInfo management.
Public classSearchExtensions
Extension methods for the pages smart search
Public classSimpleDocumentImportHandler
Simple document import handler
Public classSimpleWorkflowHandler
Simple Workflow handler
Public classSystemDocumentTypes
System document types
Public classTaxonomyDocumentQueryExtensions
Encapsulates extension method for IDocumentQuery objects.
Public classTemporaryAttachmentsCleaner
Provides an ITask interface for the temporary attachments deletion.
Public classTransformationInfo
Class to use for storing the transformation data.
Public classTransformationInfoProvider
Enables access to Transformations.
Public classTreeNode
Represents a document
Public classTreeNodeCollection
Document collection.
Public classTreeNodeCollectionNodeType
Generic strongly typed info object collection
Public classTreeNodeCollectionMethods
TreeNodeCollection methods - wrapping methods for macro resolver.
Public classTreeNodeCollectionSettings
Collection settings for Document collection
Public classTreeNodeRepository
Repository of the documents without workflow support.
Public classTreeNodeTypeExtensions
Extension methods to identify page features based on page type.
Public classTreeNodeTypeInfo
Type info for the tree node
Public classTreePathUtils
Provides static helper methods for converting and validating paths, aliases and names.
Public classTreeProvider
Provides methods for management of the tree structure.
Public classTreeSecurityProvider
Tree provider with an additional security functionality to filter the selection results by the user permissions.
Public classUpdateAttachmentWebFarmTask
Web farm task used to update attachment of documents.
Public classUserDocumentsListInfo
Defines the listing info for user documents
Public classUserSecurityExtensions
Security extensions for users
Public classVersionAttachmentInfo
Version attachment binding info.
Public classVersionAttachmentInfoProvider
Class providing VersionAttachmentInfo management.
Public classVersionHistoryInfo
VersionHistoryInfo data container class.
Public classVersionHistoryInfoProvider
Class providing VersionHistoryInfo management.
Public classVersionManager
Class to provide node versioning management.
Public classWorkflowActionHandler
Workflow action handler
Public classWorkflowEmailSender
Class for asynchronous workflow e-mail sending.
Public classWorkflowEventArgs
Workflow event arguments
Public classWorkflowEvents
Workflow events
Public classWorkflowException
Special workflow exception.
Public classWorkflowHandler
Workflow handler
Public classWorkflowManager
Class for managing the workflow procedure.
Public classWorkflowResolvers
Resolvers used in e-mail templates and other macro visual components.
Public classWorkflowTimer
Provides an ITask interface for the workflow timing.
Interfaces
  InterfaceDescription
Public interfaceIAclInfoProvider
Declares members for AclInfo management.
Public interfaceIAclItemInfoProvider
Declares members for AclItemInfo management.
Public interfaceIAllowedChildClassInfoProvider
Declares members for AllowedChildClassInfo management.
Public interfaceIAlternativeUrlInfoProvider
Declares members for AlternativeUrlInfo management.
Public interfaceIAttachment
Attachment interface to unify access to attachment objects.
Public interfaceIAttachmentHistoryInfoProvider
Declares members for AttachmentHistoryInfo management.
Public interfaceIAttachmentInfoProvider
Declares members for AttachmentInfo management.
Public interfaceIDocumentCategoryInfoProvider
Declares members for DocumentCategoryInfo management.
Public interfaceIDocumentFactory
Interface for the document factory
Public interfaceIDocumentQuery
Document query parameters interface
Public interfaceIDocumentQueryTQuery, TObject
Document query parameters interface for a specific query
Public interfaceIDocumentTagInfoProvider
Declares members for DocumentTagInfo management.
Public interfaceIDocumentTypeScopeClassInfoProvider
Declares members for DocumentTypeScopeClassInfo management.
Public interfaceIDocumentTypeScopeInfoProvider
Declares members for DocumentTypeScopeInfo management.
Public interfaceIMultiDocumentQuery
Multi document query interface
Public interfaceIMultiDocumentQueryTQuery, TInnerQuery, TObject
Multi document query interface for a specific query
Public interfaceIPageFormerUrlPathInfoProvider
Declares members for PageFormerUrlPathInfo management.
Public interfaceIPageTemplateConfigurationInfoProvider
Declares members for PageTemplateConfigurationInfo management.
Public interfaceIPageUrlPathInfoProvider
Declares members for PageUrlPathInfo management.
Public interfaceIRelationshipInfoProvider
Declares members for RelationshipInfo management.
Public interfaceIVersionAttachmentInfoProvider
Declares members for VersionAttachmentInfo management.
Public interfaceIVersionHistoryInfoProvider
Declares members for VersionHistoryInfo management.
Delegates
Enumerations
  EnumerationDescription
Public enumerationDocumentOrderEnum
Document order enumeration (for new document).
Public enumerationDocumentSortEnum
Documents sort type enumeration.
Public enumerationHomePageUrlBehaviorEnum
Home page URL behavior options.
Public enumerationIconType
Document con type enumeration
Public enumerationIncludeCoupledDataEnum
Indicates how coupled data columns are included in the multiple documents query.
Public enumerationNodePermissionsEnum
Node permissions enumeration.
Public enumerationPageLocationEnum
Page location enumeration.
Public enumerationPathTypeEnum
Path type enumeration.
Public enumerationRelationshipSideEnum
Relationship side enumeration.
Public enumerationTransformationTypeEnum
Transformation type enumeration.
Public enumerationTranslationStatusEnum
Translation status enumeration.
Public enumerationUrlOptionsEnum
Defines format of culture specific URLs. Enum is Flags enum.