| IPropertiesFactoryCreateStructureInfo Method (IContextInfo, Boolean, IStructureInfo) |
Creates a document structure object that can be used to help define the
outline of the document
Namespace: Sdl.FileTypeSupport.Framework.NativeApiAssembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2343.0)
SyntaxIStructureInfo CreateStructureInfo(
IContextInfo contextInfo,
bool mustUseDisplayName,
IStructureInfo parentStructure
)
Function CreateStructureInfo (
contextInfo As IContextInfo,
mustUseDisplayName As Boolean,
parentStructure As IStructureInfo
) As IStructureInfo
IStructureInfo^ CreateStructureInfo(
IContextInfo^ contextInfo,
bool mustUseDisplayName,
IStructureInfo^ parentStructure
)
abstract CreateStructureInfo :
contextInfo : IContextInfo *
mustUseDisplayName : bool *
parentStructure : IStructureInfo -> IStructureInfo
Parameters
- contextInfo
- Type: Sdl.FileTypeSupport.Framework.NativeApiIContextInfo
The context info in the document to which the
structural info relates. - mustUseDisplayName
- Type: SystemBoolean
True if the client should always
show the DisplayName property. False if the client
should attempt to display the matching text in the document. Note: setting
this parameter to true also makes sure that the structure will appear in the tree; setting
this parameter to false allows the client to decide whether it should be displayed. - parentStructure
- Type: Sdl.FileTypeSupport.Framework.NativeApiIStructureInfo
The parent structure in the structural tree
(can be null if it has no parent)
Return Value
Type:
IStructureInfo[Missing <returns> documentation for "M:Sdl.FileTypeSupport.Framework.NativeApi.IPropertiesFactory.CreateStructureInfo(Sdl.FileTypeSupport.Framework.NativeApi.IContextInfo,System.Boolean,Sdl.FileTypeSupport.Framework.NativeApi.IStructureInfo)"]
See Also
Comments