UrlOptionsEnum Enumeration

Xperience 13 API Reference

Namespaces

CMS Namespaces

CMS.DocumentEngine Namespaces

CMS.DocumentEngine

AclInfo Class

AclInfoProvider Class

AclItemInfo Class

AclItemInfoProvider Class

AllowedChildClassInfo Class

AllowedChildClassInfoProvider Class

AlternativeUrlCollisionData Class

AlternativeUrlInfo Class

AlternativeUrlInfoProvider Class

AlternativeUrlValidatorTask Class

AttachmentBinaryHelper Class

AttachmentExtensions Class

AttachmentHistoryExtensions Class

AttachmentHistoryInfo Class

AttachmentHistoryInfoProvider Class

AttachmentInfo Class

AttachmentInfoProvider Class

AttachmentInfoProviderExtensions Class

AttachmentSource Class

AttachmentURLProvider Class

AttachmentVariantContext Class

AttachmentVariantContextScope Class

BaseDocumentAction Class

BaseDocumentSettings Class

BaseLogDocumentChangeSettings Class

ClearDocumentFieldsTypeInfosWebFarmTask Class

ClearDocumentTypeInfosWebFarmTask Class

ClearResolvedClassNamesWebFarmTask Class

CMSDataContext Class

CMSDataContextBase(ParentType) Class

CMSOutputAttachment Class

CMSSiteDataContext Class

CombinedDocumentAttachmentCollection Class

CombinedTreeNodeCollection Class

ContentMethods Class

ContentPublisher Class

ContentTransformationFunctions Class

CopyDocumentAction Class

CopyDocumentSettings Class

CopyNodeDataSettings Class

CreateSearchFieldsEventArgs Class

CreateSearchFieldsForPageEventArgs Class

CreateSearchFieldsForPageHandler Class

CreateSearchFieldsHandler Class

DeleteAttachmentWebFarmTask Class

DeleteDocumentAction Class

DeleteDocumentSettings Class

DocumentActionContext Class

DocumentAttachment Class

DocumentAttachmentCollection Class

DocumentAttachmentExtensions Class

DocumentAttachmentRepository Class

DocumentAuthorizationEventArgs Class

DocumentAuthorizationHandler Class

DocumentCategoryInfo Class

DocumentCategoryInfoProvider Class

DocumentCategorySearchIndexer Class

DocumentChangeOrderEventArgs Class

DocumentChangeOrderEventArgs(TDocument) Class

DocumentChangeOrderHandler Class

DocumentClassNameRetriever Class

DocumentColumnLists Class

DocumentCultureNotAllowedException Class

DocumentDataEventArgs Class

DocumentDataEventHandler Class

DocumentDependencyCacheKeysBuilder Class

DocumentEngineModule Class

DocumentEngineModuleMetadata Class

DocumentEventArgs Class

DocumentEvents Class

DocumentExport Class

DocumentFactory(NodeType) Class

DocumentFieldDataType Class

DocumentFieldsTypeInfo Class

DocumentFileDeleteJob Class

DocumentFormFieldInfoExtensions Class

DocumentGenerator Class

DocumentHandler Class

DocumentHelper Class

DocumentHelper.OnAfterDocumentDeletedEventHandler Delegate

DocumentHierarchyHelper Class

DocumentImportExportEvents Class

DocumentImportHandler Class

DocumentMarkEventArgs Class

DocumentMarkHandler Class

DocumentOrderEnum Enumeration

DocumentPropertyAction Class

DocumentQuery Class

DocumentQuery(TDocument) Class

DocumentQueryBase(TQuery, TObject) Class

DocumentQueryProperties Class

DocumentSearchEventArgs Class

DocumentSearchHandler Class

DocumentSearchIndexer Class

DocumentSecurityEventArgs Class

DocumentSecurityEventArgs(TDocument) Class

DocumentSecurityHandler Class

DocumentSecurityHelper Class

DocumentsExportEventArgs Class

DocumentsExportHandler Class

DocumentsImportEventArgs Class

DocumentsImportHandler Class

DocumentSortEnum Enumeration

DocumentSortEventArgs Class

DocumentSortEventArgs(TDocument) Class

DocumentSortHandler Class

DocumentSynchronizationHelper Class

DocumentSystemColumns Class

DocumentTagInfo Class

DocumentTagInfoProvider Class

DocumentTypeHelper Class

DocumentTypeInfo Class

DocumentTypeNotExistsException Class

DocumentTypeScopeClassInfo Class

DocumentTypeScopeClassInfoProvider Class

DocumentTypeScopeInfo Class

DocumentTypeScopeInfoProvider Class

DocumentTypeScopeResolvers Class

DocumentURLProvider Class

DocumentWorkflowAction Class

DynamicTreeNodeTypeInfo Class

EditableItems Class

EmailAction Class

HomePageUrlBehaviorEnum Enumeration

IAclInfoProvider Interface

IAclItemInfoProvider Interface

IAllowedChildClassInfoProvider Interface

IAlternativeUrlInfoProvider Interface

IAttachment Interface

IAttachmentHistoryInfoProvider Interface

IAttachmentInfoProvider Interface

IconType Enumeration

IDocumentCategoryInfoProvider Interface

IDocumentFactory Interface

IDocumentQuery Interface

IDocumentQuery(TQuery, TObject) Interface

IDocumentTagInfoProvider Interface

IDocumentTypeScopeClassInfoProvider Interface

IDocumentTypeScopeInfoProvider Interface

IMultiDocumentQuery Interface

IMultiDocumentQuery(TQuery, TInnerQuery, TObject) Interface

IncludeCoupledDataEnum Enumeration

InvalidAlternativeUrlException Class

InvalidateDocumentFieldsTypeInfoWebFarmTask Class

InvalidateDocumentTypeInfoWebFarmTask Class

IPageFormerUrlPathInfoProvider Interface

IPageTemplateConfigurationInfoProvider Interface

IPageUrlPathInfoProvider Interface

IRelationshipInfoProvider Interface

IVersionAttachmentInfoProvider Interface

IVersionHistoryInfoProvider Interface

LinkDocumentAction Class

LogAction Class

LogDocumentChangeEventArgs Class

LogDocumentChangeHandler Class

LogDocumentChangeSettings Class

LogMultipleDocumentChangeSettings Class

MoveDocumentAction Class

MoveDocumentSettings Class

MultiDocumentQuery Class

MultiDocumentQueryBase(TQuery, TInnerQuery, TObject) Class

NewCultureDocumentSettings Class

NodePermissionsEnum Enumeration

NodeSelectionParameters Class

NormalizedAlternativeUrl Class

NotificationEmailsAction Class

PageFormerUrlPathInfo Class

PageFormerUrlPathInfoListingInfo Class

PageFormerUrlPathInfoProvider Class

PageLocationEnum Enumeration

PageResolvers Class

PageSecurityHelper Class

PageTemplateConfigurationInfo Class

PageTemplateConfigurationInfoProvider Class

PageTypeFeaturesDocumentQueryExtensions Class

PageUrlPathInfo Class

PageUrlPathInfoProvider Class

PathTypeEnum Enumeration

PresentationUrlRedirect Class

RelationshipInfo Class

RelationshipInfoProvider Class

RelationshipSideEnum Enumeration

SearchExtensions Class

SimpleDocumentImportHandler Class

SimpleWorkflowHandler Class

SystemDocumentTypes Class

TaxonomyDocumentQueryExtensions Class

TemporaryAttachmentsCleaner Class

TransformationInfo Class

TransformationInfoProvider Class

TransformationTypeEnum Enumeration

TranslationStatusEnum Enumeration

TreeNode Class

TreeNodeCollection Class

TreeNodeCollection(NodeType) Class

TreeNodeCollectionMethods Class

TreeNodeCollectionSettings Class

TreeNodeRepository Class

TreeNodeTypeExtensions Class

TreeNodeTypeInfo Class

TreePathUtils Class

TreeProvider Class

TreeSecurityProvider Class

UpdateAttachmentWebFarmTask Class

UrlOptionsEnum Enumeration

UserDocumentsListInfo Class

UserSecurityExtensions Class

VersionAttachmentInfo Class

VersionAttachmentInfoProvider Class

VersionHistoryInfo Class

VersionHistoryInfoProvider Class

VersionManager Class

WorkflowActionHandler Class

WorkflowEmailSender Class

WorkflowEventArgs Class

WorkflowEvents Class

WorkflowException Class

WorkflowHandler Class

WorkflowManager Class

WorkflowResolvers Class

WorkflowTimer Class

UrlOptionsEnum Enumeration

Defines format of culture specific URLs. Enum is Flags enum.

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 13.0.131

Syntax

Copy

[FlagsAttribute]
public enum UrlOptionsEnum

Members

Member name	Value	Description
Default	1	URLs for not translated documents should be generated an URLs are not culture specific.
ExcludeUntranslatedDocuments	2	URLs of not existing culture versions will not be generated.
UseCultureSpecificURLs	4	Returns URL for the document aliasPath and document URL path (preferable if document URL path is not wildcard URL). Without this option the culture code or alias is added to the URL as a query parameter.

Reference

CMS.DocumentEngine Namespace