ISiteCreateDITAAlias Method
|
Creates a new
DITA Alias with specific
DITA Asset.
Namespace: Ingeniux.CMSAssembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxIDITAAlias CreateDITAAlias(
IAsset ditaAsset,
IPage parentPage,
string[] pubTargetIds,
bool accuracyMode,
bool includeNonDitaContent = false,
bool insertAtBeginning = false
)
Function CreateDITAAlias (
ditaAsset As IAsset,
parentPage As IPage,
pubTargetIds As String(),
accuracyMode As Boolean,
Optional includeNonDitaContent As Boolean = false,
Optional insertAtBeginning As Boolean = false
) As IDITAAlias
IDITAAlias^ CreateDITAAlias(
IAsset^ ditaAsset,
IPage^ parentPage,
array<String^>^ pubTargetIds,
bool accuracyMode,
bool includeNonDitaContent = false,
bool insertAtBeginning = false
)
abstract CreateDITAAlias :
ditaAsset : IAsset *
parentPage : IPage *
pubTargetIds : string[] *
accuracyMode : bool *
?includeNonDitaContent : bool *
?insertAtBeginning : bool
(* Defaults:
let _includeNonDitaContent = defaultArg includeNonDitaContent false
let _insertAtBeginning = defaultArg insertAtBeginning false
*)
-> IDITAAlias Parameters
- ditaAsset IAsset
- The asset to create alias for
- parentPage IPage
- The parent Page to create the new Page under
- pubTargetIds String
- The publishing target ids for which to create alias versions
- accuracyMode Boolean
- 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 Boolean (Optional)
- Whether to include non dita content in alias structure
- insertAtBeginning Boolean (Optional)
- Whether to place the Page before or after the existing child Pages
Return Value
IDITAAliasThe created new
Alias
Exceptions
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