Interface IStructureInfo

Structural information to help define how a context should act in a structural tree.

Inherited Members

System.ICloneable.Clone()

Namespace: Sdl.FileTypeSupport.Framework.NativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IStructureInfo : ICloneable

Properties

ContextInfo

The context to be used to help define the structure of the document

Declaration

IContextInfo ContextInfo { get; set; }

Property Value

Type	Description
IContextInfo

Id

A unique id for this structure info. This id is generated automatically by the implementation, and cannot be changed.

Declaration

string Id { get; }

Property Value

Type	Description
System.String

Remarks

This id is ignored when comparing objects through the Equals() implementation. This is used to facilitate comparison of different instances with the same properties.

MustUseDisplayName

True if the display name provided by the context is the one that must always be used when displaying the context in a structural tree, etc. This is usually the case if a context does not have any other text associated with it, for example, an image or a table. If this is false, the client application can try and display some more useful information to the user, for example, the corresponding text in a paragraph context.

Declaration

bool MustUseDisplayName { get; set; }

Property Value

Type	Description
System.Boolean

ParentStructure

The structural info of which this context is a child

Declaration

IStructureInfo ParentStructure { get; set; }

Property Value

Type	Description
IStructureInfo