com.spire.doc.documents
Class StructureDocumentTag

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.BodyRegion
                      com.spire.doc.documents.StructureDocumentTag

All Implemented Interfaces:

IBodyRegion, IStructureDocument, ICompositeObject, IDocumentObject, IDocumentSerializable

public class StructureDocumentTag
extends BodyRegion
implements IStructureDocument

This element specifies the presence of a structured document tag around one or more block-level structures (paragraphs, tables, etc.). The two child elements of this element shall be used to specify the properties and content of the current structured document tag via the sdtPr and sdtContent elements, respectively.

Constructor Summary

StructureDocumentTag(Document doc)
Initializes a new instance of the Block-Level structured document tag class.

Method Summary

TextSelection	find(java.util.regex.Pattern pattern) Returns first entry of given regex.
CharacterFormat	getBreakCharacterFormat() Gets character format for the break symbol.
DocumentObjectCollection	getChildObjects() Gets the child entities.
DocumentObjectType	getDocumentObjectType() Gets the type of the entity.
int	getIndex(IDocumentObject entity) Returns the zero-based index of the specified entity.
SDTContent	getSDTContent() Gets the a value specifies the last known contents of a structured document tag around one or more block-level structures.
SDTProperties	getSDTProperties() Gets the structured document tag properties.
int	replace(java.util.regex.Pattern pattern, java.lang.String replace) Replaces all entries of matchString regular expression with newValue string.
int	replace(java.util.regex.Pattern pattern, TextSelection textSelection) Replaces all entries of matchString regular expression with TextRangesHolder.
int	replace(java.util.regex.Pattern pattern, TextSelection textSelection, boolean saveFormatting) Replaces all entries of matchString regular expression with TextRangesHolder.
int	replace(java.lang.String given, java.lang.String replace, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString string with newValue string, taking into consideration caseSensitive and wholeWord options.
int	replace(java.lang.String given, TextSelection textSelection, boolean caseSensitive, boolean wholeWord) Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.
int	replace(java.lang.String given, TextSelection textSelection, boolean caseSensitive, boolean wholeWord, boolean saveFormatting) Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.
void	updateDataBinding() Updates stuctured documnet tag content with bound data.

Methods inherited from class com.spire.doc.BodyRegion

getDeleteRevision, getInsertRevision, getOwnerTextBody, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getNextWidgetSibling, getOwner, getPreviousSibling, getPreviousWidgetSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

StructureDocumentTag

public StructureDocumentTag(Document doc)

Initializes a new instance of the Block-Level structured document tag class.

Parameters:

doc - The doc.

Method Detail

getSDTContent

public SDTContent getSDTContent()

Gets the a value specifies the last known contents of a structured document tag around one or more block-level structures.

getSDTProperties

public SDTProperties getSDTProperties()

Gets the structured document tag properties.

Specified by:

getSDTProperties in interface IStructureDocument

Returns:

SDTProperties

getBreakCharacterFormat

public CharacterFormat getBreakCharacterFormat()

Gets character format for the break symbol.

Specified by:

getBreakCharacterFormat in interface IStructureDocument

Returns:

CharacterFormat

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the entity.

Specified by:

getDocumentObjectType in interface IDocumentObject

Specified by:

getDocumentObjectType in class DocumentObject

Returns:

The type of the entity.

getChildObjects

public DocumentObjectCollection getChildObjects()

Gets the child entities.

Specified by:

getChildObjects in interface ICompositeObject

Specified by:

getChildObjects in class DocumentObject

Returns:

The child entities.

getIndex

public int getIndex(IDocumentObject entity)

Returns the zero-based index of the specified entity.

Parameters:

entity - the document object.

Returns:

updateDataBinding

public void updateDataBinding()

Updates stuctured documnet tag content with bound data.

Specified by:

updateDataBinding in interface IStructureDocument

replace

public int replace(java.util.regex.Pattern pattern,
                   java.lang.String replace)

Replaces all entries of matchString regular expression with newValue string.

Specified by:

replace in interface IBodyRegion

Specified by:

replace in class BodyRegion

Parameters:

pattern - the Pattern

replace - replace String

Returns:

int

replace

public int replace(java.lang.String given,
                   java.lang.String replace,
                   boolean caseSensitive,
                   boolean wholeWord)

Replaces all entries of matchString string with newValue string, taking into consideration caseSensitive and wholeWord options.

Specified by:

replace in class BodyRegion

Parameters:

matchString - The matchString text to newValue.

newValue - The newValue text .

caseSensitive - if specifies case sensitive, set to true .

wholeWord - if it specifies to search a whole word, set to true.

Returns:

replace

public int replace(java.util.regex.Pattern pattern,
                   TextSelection textSelection)

Replaces all entries of matchString regular expression with TextRangesHolder.

Specified by:

replace in interface IBodyRegion

Specified by:

replace in class BodyRegion

Parameters:

pattern - The pattern.

textSelection - The text selection.

Returns:

int

replace

public int replace(java.util.regex.Pattern pattern,
                   TextSelection textSelection,
                   boolean saveFormatting)

Replaces all entries of matchString regular expression with TextRangesHolder.

Specified by:

replace in class BodyRegion

Parameters:

pattern - The pattern.

textSelection - The text selection.

saveFormatting - if it specifies save source formatting, set to true.

Returns:

int

replace

public int replace(java.lang.String given,
                   TextSelection textSelection,
                   boolean caseSensitive,
                   boolean wholeWord)

Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.

Parameters:

matchString - The matchString.

textSelection - The text selection.

caseSensitive - if it specifies case sensitive, set to true.

wholeWord - if it specifies to check whole word, set to true .

replace

public int replace(java.lang.String given,
                   TextSelection textSelection,
                   boolean caseSensitive,
                   boolean wholeWord,
                   boolean saveFormatting)

Replaces all entries of matchString string with TextRangesHolder, taking into consideration caseSensitive and wholeWord options.

Parameters:

matchString - The matchString.

textSelection - The text selection.

caseSensitive - if it specifies case sensitive, set to true .

wholeWord - if it specifies to search a whole word, set to true .

saveFormatting - if it specifies save source formatting, set to true.

Returns:

find

public TextSelection find(java.util.regex.Pattern pattern)

Returns first entry of given regex.

Specified by:

find in class BodyRegion

Parameters:

pattern - The pattern.

Returns:

TextSelection