IStructuredDocumentTag

public interface IStructuredDocumentTag

Интерфейс для определения общих данных дляStructuredDocumentTag а такжеStructuredDocumentTagRangeStart.

Методы

МетодОписание
getColor()Получает цвет тега структурированного документа.
getId()Указывает уникальный постоянный числовой идентификатор только для чтения для этогоSDT.
getLevel()Получает уровень, на котором этоSDT происходит в дереве документов.
getLockContentControl()Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.
getLockContents()Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.
getPlaceholder()ПолучаетBuildingBlockсодержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано в параметреgetXmlMapping() элемент илиisShowingPlaceholderText() / isShowingPlaceholderText(boolean) элемент истинный.
getPlaceholderName()Получает или задает имяBuildingBlock содержащий текст-заполнитель.
getSdtType()Получает тип этогоStructured document tag.
getTag()Задает тег, связанный с текущим узлом SDT.
getTitle()Указывает понятное имя, связанное с этимSDT.
getWordOpenXML()Получает строку, представляющую XML, содержащийся в узле вSaveFormat.FLAT_OPC формат.
getXmlMapping()Получает объект, представляющий сопоставление этого тега структурированного документа с XML-данными в пользовательской XML-части текущего документа.
isRanged()Возвращает true, если этот экземпляр является ранжированным структурированным тегом документа.
isShowingPlaceholderText()Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).
isShowingPlaceholderText(boolean value)Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).
setColor(Color value)Задает цвет тега структурированного документа.
setLockContentControl(boolean value)Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.
setLockContents(boolean value)Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.
setPlaceholderName(String value)Получает или задает имяBuildingBlock содержащий текст-заполнитель.
setTag(String value)Задает тег, связанный с текущим узлом SDT.
setTitle(String value)Указывает понятное имя, связанное с этимSDT.
structuredDocumentTagNode()Возвращает объект Node, реализующий этот интерфейс.

getColor()

public abstract Color getColor()

Получает цвет тега структурированного документа.

Возвращает: java.awt.Color — цвет тега структурированного документа.

getId()

public abstract int getId()

Указывает уникальный постоянный числовой идентификатор только для чтения для этогоSDT.

Возвращает: int - соответствующее значение int.

getLevel()

public abstract int getLevel()

Получает уровень, на котором этоSDT происходит в дереве документов.

Возвращает: int - Уровень, на котором этоSDT происходит в дереве документов. Возвращаемое значение является одним изMarkupLevel константы.

getLockContentControl()

public abstract boolean getLockContentControl()

Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.

Возвращает: boolean - соответствующее логическое значение.

getLockContents()

public abstract boolean getLockContents()

Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.

Возвращает: boolean - соответствующее логическое значение.

getPlaceholder()

public abstract BuildingBlock getPlaceholder()

ПолучаетBuildingBlockсодержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано в параметреgetXmlMapping() элемент илиisShowingPlaceholderText() / isShowingPlaceholderText(boolean) элемент истинный. Может быть нулевым, что означает, что заполнитель неприменим для этого Sdt.

Возвращает: BuildingBlock -BuildingBlockсодержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано в параметреgetXmlMapping() элемент илиisShowingPlaceholderText() / isShowingPlaceholderText(boolean) элемент истинный.

getPlaceholderName()

public abstract String getPlaceholderName()

Получает или задает имяBuildingBlock содержащий текст-заполнитель.

BuildingBlock с этим названиемBuildingBlock.getName() / BuildingBlock.setName(java.lang.String) должен присутствовать вDocument.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) в противном случае возникнет исключение java.lang.IllegalStateException.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getSdtType()

public abstract int getSdtType()

Получает тип этогоStructured document tag.

Возвращает: int - Тип этогоStructured document tag . Возвращаемое значение является одним изSdtType константы.

getTag()

public abstract String getTag()

Задает тег, связанный с текущим узлом SDT. Не может быть нулевым.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getTitle()

public abstract String getTitle()

Указывает понятное имя, связанное с этимSDT. Не может быть нулевым.

Возвращает: java.lang.String — соответствующее значение java.lang.String.

getWordOpenXML()

public abstract String getWordOpenXML()

Получает строку, представляющую XML, содержащийся в узле вSaveFormat.FLAT_OPC формат.

Возвращает: java.lang.String — строка, представляющая XML, содержащийся в узле вSaveFormat.FLAT_OPC формат.

getXmlMapping()

public abstract XmlMapping getXmlMapping()

Получает объект, представляющий сопоставление этого тега структурированного документа с XML-данными в пользовательской XML-части текущего документа. Вы можете использоватьXmlMapping.setMapping(com.aspose.words.CustomXmlPart, java.lang.String, java.lang.String) метод этого объекта для сопоставления тега структурированного документа с данными XML.

Возвращает: XmlMapping - Объект, представляющий сопоставление этого тега структурированного документа с данными XML в пользовательской части XML текущего документа.

isRanged()

public abstract boolean isRanged()

Возвращает true, если этот экземпляр является ранжированным структурированным тегом документа.

Возвращает: логический

isShowingPlaceholderText()

public abstract boolean isShowingPlaceholderText()

Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).

если установлено значение true, это состояние должно быть возобновлено (показывая текст-заполнитель) при открытии этого документа.

Возвращает: boolean - соответствующее логическое значение.

isShowingPlaceholderText(boolean value)

public abstract void isShowingPlaceholderText(boolean value)

Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).

если установлено значение true, это состояние должно быть возобновлено (показывая текст-заполнитель) при открытии этого документа.

Параметры:

ПараметрТипОписание
valuebooleanСоответствующее логическое значение.

setColor(Color value)

public abstract void setColor(Color value)

Задает цвет тега структурированного документа.

Параметры:

ПараметрТипОписание
valuejava.awt.ColorЦвет тега структурированного документа.

setLockContentControl(boolean value)

public abstract void setLockContentControl(boolean value)

Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.

Параметры:

ПараметрТипОписание
valuebooleanСоответствующее логическое значение.

setLockContents(boolean value)

public abstract void setLockContents(boolean value)

Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.

Параметры:

ПараметрТипОписание
valuebooleanСоответствующее логическое значение.

setPlaceholderName(String value)

public abstract void setPlaceholderName(String value)

Получает или задает имяBuildingBlock содержащий текст-заполнитель.

BuildingBlock с этим названиемBuildingBlock.getName() / BuildingBlock.setName(java.lang.String) должен присутствовать вDocument.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) в противном случае возникнет исключение java.lang.IllegalStateException.

Параметры:

ПараметрТипОписание
valuejava.lang.StringСоответствующее значение java.lang.String.

setTag(String value)

public abstract void setTag(String value)

Задает тег, связанный с текущим узлом SDT. Не может быть нулевым.

Параметры:

ПараметрТипОписание
valuejava.lang.StringСоответствующее значение java.lang.String.

setTitle(String value)

public abstract void setTitle(String value)

Указывает понятное имя, связанное с этимSDT. Не может быть нулевым.

Параметры:

ПараметрТипОписание
valuejava.lang.StringСоответствующее значение java.lang.String.

structuredDocumentTagNode()

public abstract Node structuredDocumentTagNode()

Возвращает объект Node, реализующий этот интерфейс.

Возвращает: Node