ISiteCreateDITAAlias Method
|
Creates a new
DITA Alias with specific
DITA Asset.
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax IDITAAlias CreateDITAAlias(
IAsset ditaAsset,
IPage parentPage,
bool accuracyMode,
bool includeNonDitaContent = false,
bool insertAtBeginning = false
)
Function CreateDITAAlias (
ditaAsset As IAsset,
parentPage As IPage,
accuracyMode As Boolean,
Optional includeNonDitaContent As Boolean = false,
Optional insertAtBeginning As Boolean = false
) As IDITAAlias
IDITAAlias^ CreateDITAAlias(
IAsset^ ditaAsset,
IPage^ parentPage,
bool accuracyMode,
bool includeNonDitaContent = false,
bool insertAtBeginning = false
)
abstract CreateDITAAlias :
ditaAsset : IAsset *
parentPage : IPage *
accuracyMode : bool *
?includeNonDitaContent : bool *
?insertAtBeginning : bool
(* Defaults:
let _includeNonDitaContent = defaultArg includeNonDitaContent false
let _insertAtBeginning = defaultArg insertAtBeginning false
*)
-> IDITAAlias
Parameters
- ditaAsset
- Type: Ingeniux.CMSIAsset
The asset to create alias for - parentPage
- Type: Ingeniux.CMSIPage
The parent Page to create the new Page under - accuracyMode
- Type: SystemBoolean
Whether to create alias via actual dita content instead of dependency. Creating with content is much more accurate and represent actual structure of dita content, but also much slower - includeNonDitaContent (Optional)
- Type: SystemBoolean
Whether to include non dita content in alias structure - insertAtBeginning (Optional)
- Type: SystemBoolean
Whether to place the Page before or after the existing child Pages
Return Value
Type:
IDITAAliasThe created new
AliasExceptions Remarks
If "parentPage" parameter value is null, the new Page will be created under the Site Root.
If "name" is null or empty, it will be default to one empty space.
If "parentPage" is the Recycle Folder, error will be thrown.
The event "PageCreated" will be fired upon alias creation
See Also