com.spire.doc.documents
Class SDTProperties

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.documents.SDTProperties

All Implemented Interfaces:

IDocumentSerializable

public class SDTProperties
extends DocumentSerializable

This element specifies the set of properties that shall be applied to the nearest ancestor structured document tag.

Constructor Summary

SDTProperties(DocumentObject owner)

Method Summary

java.lang.String	getAlias() Gets or sets the an alias.
SdtAppearance	getAppearance() Gets the appearance type of a structured document tag.
CharacterFormat	getCharacterFormat() Gets the character format.
java.awt.Color	getColor() Gets the BaseColor of a structured document tag.
SdtControlProperties	getControlProperties() Encapsulates all differences between different type of SDT-based content controls.
java.math.BigDecimal	getId() Gets the id.
LockSettingsType	getLockSettings() Gets a value that specifies locking behaviors.
SdtType	getSDTType() Gets the Sdt type.
java.lang.String	getTag() Gets the a value specifies that its contents contain a string.
boolean	isShowingPlaceHolder() Gets a value indicating whether this instance is showing place holder.
void	isShowingPlaceHolder(boolean value) Sets a value indicating whether this instance is showing place holder.
boolean	isTemporary() Gets a value indicating whether remove SDT when contents are edited
void	isTemporary(boolean value) Sets a value indicating whether remove SDT when contents are edited
void	setAlias(java.lang.String value) Gets or sets the an alias.
void	setAppearance(SdtAppearance value) Sets the appearance type of a structured document tag.
void	setColor(java.awt.Color value) Sets the BaseColor of a structured document tag.
void	setControlProperties(SdtControlProperties value) Encapsulates all differences between different type of SDT-based content controls.
void	setId(java.math.BigDecimal value) Gets the id.
void	setLockSettings(LockSettingsType value) Sets a value that specifies locking behaviors.
void	setSDTType(SdtType value) Gets the Sdt type.
void	setTag(java.lang.String value) Sets the a value specifies that its contents contain a string.

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

SDTProperties

public SDTProperties(DocumentObject owner)

Method Detail

getId

public java.math.BigDecimal getId()

Gets the id. specifes that the contents of this attribute contains a decimal number.

setId

public void setId(java.math.BigDecimal value)

Gets the id. specifes that the contents of this attribute contains a decimal number.

getAlias

public java.lang.String getAlias()

Gets or sets the an alias.

setAlias

public void setAlias(java.lang.String value)

Gets or sets the an alias.

getTag

public java.lang.String getTag()

Gets the a value specifies that its contents contain a string.

Returns:

String

setTag

public void setTag(java.lang.String value)

Sets the a value specifies that its contents contain a string.

Parameters:

value - String

getControlProperties

public SdtControlProperties getControlProperties()

Encapsulates all differences between different type of SDT-based content controls.

setControlProperties

public void setControlProperties(SdtControlProperties value)

Encapsulates all differences between different type of SDT-based content controls.

getSDTType

public SdtType getSDTType()

Gets the Sdt type.

setSDTType

public void setSDTType(SdtType value)

Gets the Sdt type.

getLockSettings

public LockSettingsType getLockSettings()

Gets a value that specifies locking behaviors.

Returns:

LockSettingsType

setLockSettings

public void setLockSettings(LockSettingsType value)

Sets a value that specifies locking behaviors.

Parameters:

value - LockSettingsType

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets the character format.

Returns:

CharacterFormat

isShowingPlaceHolder

public boolean isShowingPlaceHolder()

Gets a value indicating whether this instance is showing place holder.

Returns:

boolean

isShowingPlaceHolder

public void isShowingPlaceHolder(boolean value)

Sets a value indicating whether this instance is showing place holder.

Parameters:

value - boolean value

isTemporary

public boolean isTemporary()

Gets a value indicating whether remove SDT when contents are edited

Returns:

boolean

isTemporary

public void isTemporary(boolean value)

Sets a value indicating whether remove SDT when contents are edited

Parameters:

value - boolean value

getAppearance

public SdtAppearance getAppearance()

Gets the appearance type of a structured document tag. The Property is only available in Docx_2013 or above.

Returns:

SdtAppearance

setAppearance

public void setAppearance(SdtAppearance value)

Sets the appearance type of a structured document tag. The Property is only available in Docx_2013 or above.

Parameters:

value - SdtAppearance value

setColor

public void setColor(java.awt.Color value)

Sets the BaseColor of a structured document tag. The Property is only available in Docx_2013 or above.

Parameters:

value - Color value

getColor

public java.awt.Color getColor()

Gets the BaseColor of a structured document tag. The Property is only available in Docx_2013 or above.

Returns:

Color