StructuredDocumentTag

Наследование: java.lang.Object, com.aspose.words.Node, com.aspose.words.CompositeNode

Все реализованные интерфейсы: com.aspose.words.IStructuredDocumentTag

public class StructuredDocumentTag extends CompositeNode implements IStructuredDocumentTag

Представляет тег структурированного документа (SDT или элемент управления содержимым) в документе.

Чтобы узнать больше, посетитеStructured Document Tags or Content Control документальная статья.

Теги структурированного документа (SDT) позволяют встраивать в документ определяемую пользователем семантику, а также его поведение и внешний вид.

В этой версии Aspose.Words предоставляет ряд общедоступных методов и свойств для управления поведением и содержимымStructuredDocumentTag . Сопоставление узлов SDT с пользовательскими пакетами XML в документе можно выполнить с помощьюgetXmlMapping() имущество.

StructuredDocumentTag может встречаться в документе в следующих местах:

Блочный уровень — среди абзацев и таблиц, как дочерний элементBody, HeaderFooter, Comment, Footnote илиShape узел.
Уровень строки — среди строк в таблице, как дочерний элементTable узел.
Уровень ячейки — среди ячеек в строке таблицы, как дочерний элементRow узел.
Встроенный уровень — среди встроенного контента внутри, как дочерний элементParagraph.
Вложенный в другойStructuredDocumentTag.

Конструкторы

Конструктор	Описание
StructuredDocumentTag(DocumentBase doc, int type, int level)	Инициализирует новый экземпляр этого класса.

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
appendChild(Node newChild)	Добавляет указанный узел в конец списка дочерних узлов для этого узла.
clear()	Очищает содержимое этого тега структурированного документа и отображает заполнитель, если он определен.
clearRunAttrs()
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
fetchInheritedRunAttr(int key)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getAppearance()	Получает/задает внешний вид тега структурированного документа.
getBuildingBlockCategory()	Указывает категорию стандартного блока для этогоSDT узел.
getBuildingBlockGallery()	Определяет тип стандартного блока для этогоSDT.
getCalendarType()	Указывает тип календаря для этогоSDT.
getChecked()	Получает/устанавливает текущее состояние флажкаSDT.
getChild(int nodeType, int index, boolean isDeep)
getChildNodes()	Получает все непосредственные дочерние узлы этого узла.
getChildNodes(int nodeType, boolean isDeep)
getClass()
getColor()	Получает цвет тега структурированного документа.
getContainer()
getContentsFont()	Форматирование шрифта, которое будет применяться к тексту, введенному вSDT.
getCount()	Получает количество непосредственных дочерних элементов этого узла.
getCurrentNode()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDateDisplayFormat()	Строка, представляющая формат, в котором отображаются даты.
getDateDisplayLocale()	Позволяет установить/получить языковой формат для даты, отображаемой в этомSDT.
getDateStorageFormat()	Получает/устанавливает формат, в котором дата для SDT даты сохраняется, когдаSDT привязан к узлу XML в хранилище данных документа.
getDirectRunAttr(int key)
getDocument()	Получает документ, которому принадлежит этот узел.
getEndCharacterFont()	Форматирование шрифта, которое будет применяться к последнему символу текста, введенного вSDT.
getFirstChild()	Получает первый дочерний элемент узла.
getFullDate()	Указывает полную дату и время последнего ввода этогоSDT.
getId()	Указывает уникальный постоянный числовой идентификатор только для чтения для этогоSDT.
getLastChild()	Получает последний дочерний элемент узла.
getLevel()	Получает уровень, на котором этоSDT происходит в дереве документов.
getLevel_IMarkupNode()
getListItems()	ПолучаетSdtListItemCollection связанные с этимSDT.
getLockContentControl()	Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.
getLockContents()	Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.
getMultiline()	Указывает, является ли этоSDT допускает несколько строк текста.
getNextMatchingNode(Node curNode)
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.StructuredDocumentTag.
getParentNode()	Получает непосредственного родителя этого узла.
getPlaceholder()	ПолучаетBuildingBlockсодержащий текст-заполнитель, который должен отображаться, когда содержимое этого запуска SDT пусто, связанный сопоставленный XML-элемент пуст, как указано в параметреgetXmlMapping() элемент илиisShowingPlaceholderText() / isShowingPlaceholderText(boolean) элемент истинный.
getPlaceholderName()	Получает или задает имяBuildingBlock содержащий текст-заполнитель.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getSdtType()	Получает тип этогоStructured document tag.
getStyle()	Получает Style тега структурированного документа.
getStyleName()	Получает имя стиля, примененного к тегу структурированного документа.
getTag()	Задает тег, связанный с текущим узлом SDT.
getText()	Получает текст этого узла и всех его дочерних элементов.
getTitle()	Указывает понятное имя, связанное с этимSDT.
getWordOpenXML()	Получает строку, представляющую XML, содержащийся в узле вSaveFormat.FLAT_OPC формат.
getXmlMapping()	Получает объект, представляющий сопоставление этого тега структурированного документа с XML-данными в пользовательской XML-части текущего документа.
hasChildNodes()	Возвращает true, если у этого узла есть дочерние узлы.
hashCode()
indexOf(Node child)	Возвращает индекс указанного дочернего узла в массиве дочерних узлов.
insertAfter(Node newChild, Node refChild)	Вставляет указанный узел сразу после указанного ссылочного узла.
insertBefore(Node newChild, Node refChild)	Вставляет указанный узел непосредственно перед указанным ссылочным узлом.
isComposite()	Возвращает true, так как этот узел может иметь дочерние узлы.
isRanged()
isShowingPlaceholderText()	Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).
isShowingPlaceholderText(boolean value)	Указывает, является ли содержимое этогоSDT должен интерпретироваться как содержащий текст-заполнитель (в отличие от обычного текстового содержимого в SDT).
isTemporary()	Указывает, является ли этоSDT должен быть удален из документа WordProcessingML при изменении его содержимого.
isTemporary(boolean value)	Указывает, является ли этоSDT должен быть удален из документа WordProcessingML при изменении его содержимого.
iterator()	Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
prependChild(Node newChild)	Добавляет указанный узел в начало списка дочерних узлов для этого узла.
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeAllChildren()	Удаляет все дочерние узлы текущего узла.
removeChild(Node oldChild)	Удаляет указанный дочерний узел.
removeMoveRevisions()
removeRunAttr(int key)
removeSelfOnly()	Удаляет только сам этот узел SDT, но сохраняет его содержимое в дереве документа.
removeSmartTags()	Удаляет всеSmartTag узлы-потомки текущего узла.
selectNodes(String xpath)	Выбирает список узлов, соответствующих выражению XPath.
selectSingleNode(String xpath)	Выбирает первый узел, соответствующий выражению XPath.
setAppearance(int value)	Получает/задает внешний вид тега структурированного документа.
setBuildingBlockCategory(String value)	Указывает категорию стандартного блока для этогоSDT узел.
setBuildingBlockGallery(String value)	Определяет тип стандартного блока для этогоSDT.
setCalendarType(int value)	Указывает тип календаря для этогоSDT.
setChecked(boolean value)	Получает/устанавливает текущее состояние флажкаSDT.
setCheckedSymbol(int characterCode, String fontName)	Задает символ, используемый для представления отмеченного состояния элемента управления содержимым флажка.
setColor(Color value)	Задает цвет тега структурированного документа.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setDateDisplayFormat(String value)	Строка, представляющая формат, в котором отображаются даты.
setDateDisplayLocale(int value)	Позволяет установить/получить языковой формат для даты, отображаемой в этомSDT.
setDateStorageFormat(int value)	Получает/устанавливает формат, в котором дата для SDT даты сохраняется, когдаSDT привязан к узлу XML в хранилище данных документа.
setFullDate(Date value)	Указывает полную дату и время последнего ввода этогоSDT.
setLockContentControl(boolean value)	Если установлено значение true, это свойство запрещает пользователю удалять этоSDT.
setLockContents(boolean value)	Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этогоSDT.
setMultiline(boolean value)	Указывает, является ли этоSDT допускает несколько строк текста.
setPlaceholderName(String value)	Получает или задает имяBuildingBlock содержащий текст-заполнитель.
setRunAttr(int key, Object value)
setStyle(Style value)	Задает стиль тега структурированного документа.
setStyleName(String value)	Задает имя стиля, применяемого к тегу структурированного документа.
setTag(String value)	Задает тег, связанный с текущим узлом SDT.
setTitle(String value)	Указывает понятное имя, связанное с этимSDT.
setUncheckedSymbol(int characterCode, String fontName)	Задает символ, используемый для представления неотмеченного состояния элемента управления содержимым флажка.
structuredDocumentTagNode()
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

StructuredDocumentTag(DocumentBase doc, int type, int level)

public StructuredDocumentTag(DocumentBase doc, int type, int level)

Инициализирует новый экземпляр этого класса.

Параметры:

Параметр	Тип	Описание
doc	DocumentBase
type	int
level	int

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

Принимает посетителя.

Перечисляет этот узел и все его дочерние элементы. Каждый узел вызывает соответствующий метод в DocumentVisitor.

Дополнительные сведения см. в шаблоне проектирования «Посетитель».

Параметры:

Параметр	Тип	Описание
visitor	DocumentVisitor	Посетитель, который будет посещать узлы.

Возвращает: boolean - Истинно, если были посещены все узлы; false, если DocumentVisitor остановил операцию перед посещением всех узлов. ЗвонкиDocumentVisitor.visitStructuredDocumentTagStart(com.aspose.words.StructuredDocumentTag) , затем звонитNode.accept(com.aspose.words.DocumentVisitor) для всех дочерних узлов смарт-тега и вызововDocumentVisitor.visitStructuredDocumentTagEnd(com.aspose.words.StructuredDocumentTag) в конце.

appendChild(Node newChild)

public Node appendChild(Node newChild)

Добавляет указанный узел в конец списка дочерних узлов для этого узла.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Если вставляемый узел был создан из другого документа, следует использоватьM:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode) чтобы импортировать узел в текущий документ. Затем импортированный узел можно вставить в текущий документ.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

clear()

public void clear()

Очищает содержимое этого тега структурированного документа и отображает заполнитель, если он определен.

Невозможно очистить содержимое тега структурированного документа, если он имеет редакции.

Если этот тег структурированного документа сопоставляется с пользовательским XML (с использованиемgetXmlMapping() свойство), указанный XML-узел очищается.

clearRunAttrs()

public void clearRunAttrs()

dd()

public void dd()

deepClone(boolean isCloneChildren)

public Node deepClone(boolean isCloneChildren)

Создает дубликат узла.

Этот метод служит конструктором копирования для узлов. Клонированный узел не имеет родителя, но принадлежит к тому же документу, что и исходный узел.

Этот метод всегда выполняет глубокую копию узла.isCloneChildren Параметр указывает, следует ли также выполнять копирование всех дочерних узлов.

Параметры:

Параметр	Тип	Описание
isCloneChildren	boolean	Значение true, чтобы рекурсивно клонировать поддерево в указанном узле; false, чтобы клонировать только сам узел.

Возвращает: Node - Клонированный узел.

equals(Object arg0)

public boolean equals(Object arg0)

Параметры:

Параметр	Тип	Описание
arg0	java.lang.Object

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

fetchInheritedRunAttr(int key)

public Object fetchInheritedRunAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

getAncestor(int ancestorType)

public CompositeNode getAncestor(int ancestorType)

Параметры:

Параметр	Тип	Описание
ancestorType	int

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

getAncestor(Class ancestorType)

public CompositeNode getAncestor(Class ancestorType)

Получает первого предка указанного типа объекта.

Параметры:

Параметр	Тип	Описание
ancestorType	java.lang.Class	Тип объекта-предка для извлечения.

Возвращает: CompositeNode - предок указанного типа или ноль, если предок этого типа не найден.

Тип предка совпадает, если он равен ancestorType или является производным от ancestorType.

getAppearance()

public int getAppearance()

Получает/задает внешний вид тега структурированного документа.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изSdtAppearance константы.

getBuildingBlockCategory()

public String getBuildingBlockCategory()

Указывает категорию стандартного блока для этогоSDT узел. Не может быть нулевым.

Доступ к этому свойству будет работать только дляSdtType.BUILDING_BLOCK_GALLERY а такжеSdtType.DOC_PART_OBJ Типы СДТ. Он доступен только для чтенияSDT типа части документа.

Для всех других типов SDT будет иметь место исключение.

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

getBuildingBlockGallery()

public String getBuildingBlockGallery()

Определяет тип стандартного блока для этогоSDT. Не может быть нулевым.

Для всех других типов SDT будет иметь место исключение.

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

getCalendarType()

public int getCalendarType()

Указывает тип календаря для этогоSDT . По умолчаниюSdtCalendarType.DEFAULT

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изSdtCalendarType константы.

getChecked()

public boolean getChecked()

Получает/устанавливает текущее состояние флажкаSDT. Значение по умолчанию для этого свойства — false.

Доступ к этому свойству будет работать только дляSdtType.CHECKBOX Типы СДТ.

Для всех других типов SDT будет иметь место исключение.

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

getChild(int nodeType, int index, boolean isDeep)

public Node getChild(int nodeType, int index, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
index	int
isDeep	boolean

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

getChildNodes()

public NodeCollection getChildNodes()

Получает все непосредственные дочерние узлы этого узла.

Примечание,getChildNodes() эквивалентно вызову GetChildNodes(NodeType.Any, false) и создает и возвращает новую коллекцию при каждом доступе к ней.

Если дочерних узлов нет, это свойство возвращает пустую коллекцию.

Возвращает: NodeCollection - Все непосредственные дочерние узлы этого узла.

getChildNodes(int nodeType, boolean isDeep)

public NodeCollection getChildNodes(int nodeType, boolean isDeep)

Параметры:

Параметр	Тип	Описание
nodeType	int
isDeep	boolean

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

getClass()

public final native Class<?> getClass()

Возвращает: java.lang.Класс

getColor()

public Color getColor()

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

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

getContainer()

public CompositeNode getContainer()

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

getContentsFont()

public Font getContentsFont()

Форматирование шрифта, которое будет применяться к тексту, введенному вSDT.

Возвращает: Font - соответствующийFont ценность.

getCount()

public int getCount()

Получает количество непосредственных дочерних элементов этого узла.

Возвращает: int - количество непосредственных дочерних элементов этого узла.

getCurrentNode()

public Node getCurrentNode()

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

getCustomNodeId()

public int getCustomNodeId()

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Этот идентификатор можно установить и использовать произвольно. Например, как ключ для получения внешних данных.

Важное примечание: указанное значение не сохраняется в выходной файл и существует только в течение срока службы узла.

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

getDateDisplayFormat()

public String getDateDisplayFormat()

Строка, представляющая формат, в котором отображаются даты. Не может быть нулевым. Даты для английского языка (США): «мм/дд/гггг».

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

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

getDateDisplayLocale()

public int getDateDisplayLocale()

Позволяет установить/получить языковой формат для даты, отображаемой в этомSDT.

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

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

getDateStorageFormat()

public int getDateStorageFormat()

Получает/устанавливает формат, в котором дата для SDT даты сохраняется, когдаSDT привязан к узлу XML в хранилище данных документа. Значение по умолчаниюSdtDateStorageFormat.DATE_TIME

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Возвращает: int - соответствующее значение int. Возвращаемое значение является одним изSdtDateStorageFormat константы.

getDirectRunAttr(int key)

public Object getDirectRunAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

Возвращает: java.lang.Объект

getDocument()

public DocumentBase getDocument()

Получает документ, которому принадлежит этот узел.

Узел всегда принадлежит документу, даже если он только что создан и еще не добавлен в дерево или удален из дерева.

Возвращает: DocumentBase - Документ, которому принадлежит этот узел.

getEndCharacterFont()

public Font getEndCharacterFont()

Форматирование шрифта, которое будет применяться к последнему символу текста, введенного вSDT.

Возвращает: Font - соответствующийFont ценность.

getFirstChild()

public Node getFirstChild()

Получает первый дочерний элемент узла. Если нет первого дочернего узла, возвращается нуль.

Возвращает: Node - Первый дочерний узел.

getFullDate()

public Date getFullDate()

Указывает полную дату и время последнего ввода этогоSDT.

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

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

getId()

public int getId()

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

Атрибут Id должен соответствовать следующим правилам:

Документ должен сохранять идентификаторы SDT только в том случае, если весь документ клонирован.Document.deepClone().
В течениеDocumentBase.importNode(com.aspose.words.Node, boolean) Идентификатор должен быть сохранен, если импорт не вызывает конфликтов с другими идентификаторами SDT в целевом документе.
Если несколько узлов SDT задают одно и то же значение десятичного числа для атрибута Id, то первый SDT в документе должен поддерживать этот исходный идентификатор, а все последующие узлы SDT должны иметь новые идентификаторы, назначенные им при загрузке документа.
Во время автономного SDTM:Aspose.Words.Markup.StructuredDocumentTag.Clone(System.Boolean,Aspose.Words.INodeCloningListener) операции будет создан новый уникальный идентификатор для клонированного узла SDT.
Если Id не указан в исходном документе, то узлу SDT должен быть назначен новый уникальный идентификатор при загрузке документа.

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

getLastChild()

public Node getLastChild()

Получает последний дочерний элемент узла. Если последнего дочернего узла нет, возвращается нуль.

Возвращает: Node - Последний дочерний узел.

getLevel()

public int getLevel()

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

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

getLevel_IMarkupNode()

public int getLevel_IMarkupNode()

Возвращает: инт

getListItems()

public SdtListItemCollection getListItems()

ПолучаетSdtListItemCollection связанные с этимSDT.

Доступ к этому свойству будет работать только дляSdtType.COMBO_BOX или жеSdtType.DROP_DOWN_LIST Типы СДТ.

Для всех других типов SDT будет иметь место исключение.

Возвращает: SdtListItemCollection -{SdtListItemCollection связанные с этимSDT.

getLockContentControl()

public boolean getLockContentControl()

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

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

getLockContents()

public boolean getLockContents()

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

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

getMultiline()

public boolean getMultiline()

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

Доступ к этому свойству будет работать только дляSdtType.RICH_TEXT а такжеSdtType.PLAIN_TEXTтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

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

getNextMatchingNode(Node curNode)

public Node getNextMatchingNode(Node curNode)

Параметры:

Параметр	Тип	Описание
curNode	Node

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

getNextSibling()

public Node getNextSibling()

Получает узел, следующий сразу за этим узлом. Если следующего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно следующий за этим узлом.

getNodeType()

public int getNodeType()

ВозвращаетNodeType.StructuredDocumentTag.

Возвращает: инт -NodeType.StructuredDocumentTag . Возвращаемое значение является одним изNodeType константы.

getParentNode()

public CompositeNode getParentNode()

Получает непосредственного родителя этого узла.

Если узел был только что создан и еще не добавлен в дерево, или если он был удален из дерева, родитель имеет значение null.

Возвращает: CompositeNode - Непосредственный родитель этого узла.

getPlaceholder()

public BuildingBlock getPlaceholder()

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

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

getPlaceholderName()

public 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.

getPreviousSibling()

public Node getPreviousSibling()

Получает узел, непосредственно предшествующий этому узлу. Если предыдущего узла нет, возвращается нуль.

Возвращает: Node - Узел, непосредственно предшествующий этому узлу.

getRange()

public Range getRange()

ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.

Возвращает: Range - АRange объект, который представляет часть документа, содержащегося в этом узле.

getSdtType()

public int getSdtType()

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

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

getStyle()

public Style getStyle()

Получает Style тега структурированного документа. ТолькоStyleType.CHARACTER стиль илиStyleType.PARAGRAPH можно установить стиль со связанным стилем символов.

Возвращает: Style - Стиль тега структурированного документа.

getStyleName()

public String getStyleName()

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

Возвращает: java.lang.String — имя стиля, примененного к тегу структурированного документа.

getTag()

public String getTag()

Задает тег, связанный с текущим узлом SDT. Не может быть нулевым. Тег — это произвольная строка, которую приложения могут ассоциировать с SDT, чтобы идентифицировать ее, не предоставляя видимого понятного имени.

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

getText()

public String getText()

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

Возвращаемая строка включает все управляющие и специальные символы, как описано вControlChar.

Возвращает: java.lang.String

getTitle()

public String getTitle()

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

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

getWordOpenXML()

public String getWordOpenXML()

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

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

getXmlMapping()

public XmlMapping getXmlMapping()

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

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

hasChildNodes()

public boolean hasChildNodes()

Возвращает true, если у этого узла есть дочерние узлы.

Возвращает: boolean — Истинно, если у этого узла есть дочерние узлы.

hashCode()

public native int hashCode()

Возвращает: инт

indexOf(Node child)

public int indexOf(Node child)

Возвращает индекс указанного дочернего узла в массиве дочерних узлов. Возвращает -1, если узел не найден среди дочерних узлов.

Параметры:

Параметр	Тип	Описание
child	Node

Возвращает: инт

insertAfter(Node newChild, Node refChild)

public Node insertAfter(Node newChild, Node refChild)

Вставляет указанный узел сразу после указанного ссылочного узла.

Если refChild имеет значение null, вставляет newChild в начало списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. newNode размещается после refNode.

Возвращает: Node - Вставленный узел.

insertBefore(Node newChild, Node refChild)

public Node insertBefore(Node newChild, Node refChild)

Вставляет указанный узел непосредственно перед указанным ссылочным узлом.

Если refChild имеет значение null, вставляет newChild в конец списка дочерних узлов.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Узел для вставки.
refChild	Node	Узел, который является эталонным узлом. Новый дочерний элемент помещается перед этим узлом.

Возвращает: Node - Вставленный узел.

isComposite()

public boolean isComposite()

Возвращает true, так как этот узел может иметь дочерние узлы.

Возвращает: boolean — True, так как этот узел может иметь дочерние узлы.

isRanged()

public boolean isRanged()

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

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

isShowingPlaceholderText()

public boolean isShowingPlaceholderText()

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

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

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

isShowingPlaceholderText(boolean value)

public void isShowingPlaceholderText(boolean value)

Параметры:

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

isTemporary()

public boolean isTemporary()

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

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

isTemporary(boolean value)

public void isTemporary(boolean value)

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

Параметры:

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

iterator()

public Iterator iterator()

Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.

Возвращает: java.util.Iterator

nextPreOrder(Node rootNode)

public Node nextPreOrder(Node rootNode)

Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Следующий узел в порядке предварительного заказа. Null, если достигнут rootNode.

nodeTypeToString(int nodeType)

public static String nodeTypeToString(int nodeType)

Параметры:

Параметр	Тип	Описание
nodeType	int

Возвращает: java.lang.String

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

prependChild(Node newChild)

public Node prependChild(Node newChild)

Добавляет указанный узел в начало списка дочерних узлов для этого узла.

Если новый дочерний элемент уже находится в дереве, он сначала удаляется.

Параметры:

Параметр	Тип	Описание
newChild	Node	Добавляемый узел.

Возвращает: Node - Добавлен узел.

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.

Параметры:

Параметр	Тип	Описание
rootNode	Node	Верхний узел (предел) обхода.

Возвращает: Node - Предыдущий узел в порядке предварительного заказа. Null, если достигнут rootNode.

remove()

public void remove()

Удаляет себя из родителя.

removeAllChildren()

public void removeAllChildren()

Удаляет все дочерние узлы текущего узла.

removeChild(Node oldChild)

public Node removeChild(Node oldChild)

Удаляет указанный дочерний узел.

Родительский элемент oldChild устанавливается равным нулю после удаления узла.

Параметры:

Параметр	Тип	Описание
oldChild	Node	Узел для удаления.

Возвращает: Node - Удаленный узел.

removeMoveRevisions()

public void removeMoveRevisions()

removeRunAttr(int key)

public void removeRunAttr(int key)

Параметры:

Параметр	Тип	Описание
key	int

removeSelfOnly()

public void removeSelfOnly()

Удаляет только сам этот узел SDT, но сохраняет его содержимое в дереве документа.

removeSmartTags()

public void removeSmartTags()

Удаляет всеSmartTag узлы-потомки текущего узла. Этот метод не удаляет содержимое смарт-тегов.

selectNodes(String xpath)

public NodeList selectNodes(String xpath)

Выбирает список узлов, соответствующих выражению XPath.

На данный момент поддерживаются только выражения с именами элементов. Выражения, использующие имена атрибутов, не поддерживаются.

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: NodeList - Список узлов, соответствующих запросу XPath.

selectSingleNode(String xpath)

public Node selectSingleNode(String xpath)

Выбирает первый узел, соответствующий выражению XPath.

Параметры:

Параметр	Тип	Описание
xpath	java.lang.String	Выражение XPath.

Возвращает: Node - Первый узел, соответствующий запросу XPath, или нуль, если соответствующий узел не найден.

setAppearance(int value)

public void setAppearance(int value)

Получает/задает внешний вид тега структурированного документа.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изSdtAppearance константы.

setBuildingBlockCategory(String value)

public void setBuildingBlockCategory(String value)

Указывает категорию стандартного блока для этогоSDT узел. Не может быть нулевым.

Для всех других типов SDT будет иметь место исключение.

Параметры:

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

setBuildingBlockGallery(String value)

public void setBuildingBlockGallery(String value)

Определяет тип стандартного блока для этогоSDT. Не может быть нулевым.

Для всех других типов SDT будет иметь место исключение.

Параметры:

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

setCalendarType(int value)

public void setCalendarType(int value)

Указывает тип календаря для этогоSDT . По умолчаниюSdtCalendarType.DEFAULT

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изSdtCalendarType константы.

setChecked(boolean value)

public void setChecked(boolean value)

Получает/устанавливает текущее состояние флажкаSDT. Значение по умолчанию для этого свойства — false.

Доступ к этому свойству будет работать только дляSdtType.CHECKBOX Типы СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

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

setCheckedSymbol(int characterCode, String fontName)

public void setCheckedSymbol(int characterCode, String fontName)

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

Параметры:

Параметр	Тип	Описание
characterCode	int	Код символа для указанного символа.
fontName	java.lang.String	Имя шрифта, содержащего символ.

Доступ к этому методу будет работать только дляSdtType.CHECKBOX Типы СДТ.

Для всех других типов SDT будет иметь место исключение.|

setColor(Color value)

public void setColor(Color value)

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

Параметры:

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

setCustomNodeId(int value)

public void setCustomNodeId(int value)

Задает идентификатор пользовательского узла.

По умолчанию ноль.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setDateDisplayFormat(String value)

public void setDateDisplayFormat(String value)

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

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

setDateDisplayLocale(int value)

public void setDateDisplayLocale(int value)

Позволяет установить/получить языковой формат для даты, отображаемой в этомSDT.

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение.

setDateStorageFormat(int value)

public void setDateStorageFormat(int value)

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

Параметр	Тип	Описание
value	int	Соответствующее целочисленное значение. Значение должно быть одним изSdtDateStorageFormat константы.

setFullDate(Date value)

public void setFullDate(Date value)

Указывает полную дату и время последнего ввода этогоSDT.

Доступ к этому свойству будет работать только дляSdtType.DATEтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

Параметр	Тип	Описание
value	java.util.Date	Соответствующее значение java.util.Date.

setLockContentControl(boolean value)

public void setLockContentControl(boolean value)

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

Параметры:

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

setLockContents(boolean value)

public void setLockContents(boolean value)

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

Параметры:

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

setMultiline(boolean value)

public void setMultiline(boolean value)

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

Доступ к этому свойству будет работать только дляSdtType.RICH_TEXT а такжеSdtType.PLAIN_TEXTтипа СДТ.

Для всех других типов SDT будет иметь место исключение.

Параметры:

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

setPlaceholderName(String value)

public void setPlaceholderName(String value)

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

Параметры:

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

setRunAttr(int key, Object value)

public void setRunAttr(int key, Object value)

Параметры:

Параметр	Тип	Описание
key	int
value	java.lang.Object

setStyle(Style value)

public void setStyle(Style value)

Задает стиль тега структурированного документа. ТолькоStyleType.CHARACTER стиль илиStyleType.PARAGRAPH можно установить стиль со связанным стилем символов.

Параметры:

Параметр	Тип	Описание
value	Style	Стиль тега структурированного документа.

setStyleName(String value)

public void setStyleName(String value)

Задает имя стиля, применяемого к тегу структурированного документа.

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Имя стиля, примененного к тегу структурированного документа.

setTag(String value)

public void setTag(String value)

Параметры:

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

setTitle(String value)

public void setTitle(String value)

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

Параметры:

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

setUncheckedSymbol(int characterCode, String fontName)

public void setUncheckedSymbol(int characterCode, String fontName)

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

Параметры:

Параметр	Тип	Описание
characterCode	int	Код символа для указанного символа.
fontName	java.lang.String	Имя шрифта, содержащего символ.

Доступ к этому методу будет работать только дляSdtType.CHECKBOX Типы СДТ.

Для всех других типов SDT будет иметь место исключение.|

structuredDocumentTagNode()

public Node structuredDocumentTagNode()

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

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

toString()

public String toString()

Возвращает: java.lang.String

toString(SaveOptions saveOptions)

public String toString(SaveOptions saveOptions)

Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Параметры:

Параметр	Тип	Описание
saveOptions	SaveOptions	Указывает параметры, управляющие способом сохранения узла.

Возвращает: java.lang.String — содержимое узла в указанном формате.

toString(int saveFormat)

public String toString(int saveFormat)

Параметры:

Параметр	Тип	Описание
saveFormat	int

Возвращает: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Параметры:

Параметр	Тип	Описание
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Параметры:

Параметр	Тип	Описание
arg0	long
arg1	int

Stroke StructuredDocumentTagCollection