Class
SdtProperties

Base class for structured document tag (content control) properties, providing common configuration for locking, styling, data binding, and appearance.

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 user-friendly display name for the structured document tag, shown in editing interfaces.

Declaration

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

Property Value

string

DataBinding

Gets or sets the XML data binding that maps the structured document tag's content to an external XML data source node.

Declaration

cs-api-definition
public DataBinding DataBinding { get; set; }

Property Value

DataBinding

ID

Gets or sets a unique identifier for the structured document tag, used to reference it programmatically.

Declaration

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

Property Value

long

IsContentLocked

Gets whether the content within the structured document tag is locked and cannot be edited by users.

Declaration

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

Property Value

bool

IsLocked

Gets whether the structured document tag itself is locked, preventing deletion or movement of its boundary markers.

Declaration

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

Property Value

bool

IsTemporary

Gets or sets whether the structured document tag is automatically removed from the document after its content is edited once.

Declaration

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

Property Value

bool

Lock

Gets or sets the editing restrictions applied to the structured document tag, controlling whether its content or the tag itself can be modified.

Declaration

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

Property Value

Lock?

OutlineAppearance

Gets or sets the visual style of the structured document tag's outline, such as bounding box or tags.

Declaration

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

Property Value

OutlineAppearance?

OutlineColor

Gets or sets the color used to render the structured document tag's visual outline border in editing mode.

Declaration

cs-api-definition
public Color? OutlineColor { get; set; }

Property Value

Color?

Placeholder

Gets or sets the placeholder configuration that displays instructional text when the structured document tag is empty.

Declaration

cs-api-definition
public Placeholder Placeholder { get; set; }

Property Value

Placeholder

RunProperties

Gets the character formatting properties applied to the structured document tag's content.

Declaration

cs-api-definition
public CharacterProperties RunProperties { get; }

Property Value

CharacterProperties

Tag

Gets or sets a programmatic identifier string used to categorize or locate the structured document tag in code.

Declaration

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

Property Value

string

Type

Gets the type of structured document tag, determining its behavior and editing interface.

Declaration

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

Property Value

SdtType