Class
SdtProperties

Represents the common properties of a structured document tag.

Definition

Constructors

SdtProperties()

Initializes a new instance of the SdtProperties class.

Declaration

cs-api-definition
public SdtProperties()

SdtProperties(SdtProperties)

Initializes a new instance of the SdtProperties class.

Declaration

cs-api-definition
public SdtProperties(SdtProperties copyInstance)

Parameters

copyInstance

SdtProperties

SdtProperties(SdtType)

Initializes a new instance of the SdtProperties class.

Declaration

cs-api-definition
public SdtProperties(SdtType type)

Parameters

type

SdtType

Properties

Alias

Gets or sets a friendly name for the associated SDT.

Declaration

cs-api-definition
[XamlSerializable]
public string Alias { get; set; }

Property Value

string

DataBinding

Gets or sets an XML mapping (DataBinding) that relates the content of associated SDT to a specific XML node.

Declaration

cs-api-definition
[XamlCompositePropertySerializable]
public DataBinding DataBinding { get; set; }

Property Value

DataBinding

ID

Gets or sets the ID of the associated SDT.

Declaration

cs-api-definition
[XamlSerializable]
public long ID { get; set; }

Property Value

long

IsContentLocked

Gets a value that indicates whether the content can be modified.

Declaration

cs-api-definition
protected virtual bool IsContentLocked { get; }

Property Value

bool

IsLocked

Gets a value that indicates whether the annotation range can be modified.

Declaration

cs-api-definition
protected virtual bool IsLocked { get; }

Property Value

bool

IsTemporary

Gets or sets a value that indicates whether this SDT will be removed after editing its content.

Declaration

cs-api-definition
[XamlSerializable]
public bool IsTemporary { get; set; }

Property Value

bool

Lock

Gets or sets the locking behavior of the associated SDT.

Declaration

cs-api-definition
[XamlSerializable]
public Lock? Lock { get; set; }

Property Value

Lock?

OutlineAppearance

Gets or sets the outline appearance style.

Declaration

cs-api-definition
[XamlSerializable]
public OutlineAppearance? OutlineAppearance { get; set; }

Property Value

OutlineAppearance?

OutlineColor

Gets or sets the color that is used for visualizing the outline.

Declaration

cs-api-definition
[XamlSerializable]
public virtual Color? OutlineColor { get; set; }

Property Value

Color?

Placeholder

Gets or set the associated placeholder object.

Declaration

cs-api-definition
[XamlCompositePropertySerializable]
public Placeholder Placeholder { get; set; }

Property Value

Placeholder

StyleName

Gets or sets the style name for the structured document tag properties.

Declaration

cs-api-definition
public string StyleName { get; set; }

Property Value

string

Tag

Gets or sets a tag for the associated SDT.

Declaration

cs-api-definition
[XamlSerializable]
public string Tag { get; set; }

Property Value

string

Type

Gets the structured document tag type.

Declaration

cs-api-definition
public SdtType Type { get; }

Property Value

SdtType

Methods

GetBuilder(SdtRangeStart)

Provides an ISdtBuilder that generates the structured document tag's content.

Declaration

cs-api-definition
protected virtual ISdtBuilder GetBuilder(SdtRangeStart associatedSdt)

Parameters

associatedSdt

SdtRangeStart

Returns

ISdtBuilder