StructuredDocumentTagRangeStart

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

Все реализованные интерфейсы: com.aspose.words.IStructuredDocumentTag, java.lang.Итерабельный

public class StructuredDocumentTagRangeStart extends Node implements IStructuredDocumentTag, Iterable

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

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

Может быть непосредственным потомкомBody узелonly.

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

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

Методы

Метод	Описание
accept(DocumentVisitor visitor)
appendChild(Node newChild)	Добавляет указанный узел в конец диапазона stdContent.
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getChildNodes()	Получает все узлы между этим начальным узлом диапазона и конечным узлом диапазона.
getChildNodes(int nodeType, boolean isDeep)
getClass()
getColor()	Получает цвет тега структурированного документа.
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDocument()	Получает документ, которому принадлежит этот узел.
getId()	Указывает уникальный постоянный числовой идентификатор только для чтения для этого тега структурированного документа.
getLastChild()	Получает последний дочерний элемент в диапазоне stdContent.
getLevel()	Получает уровень, на котором этот диапазон тегов структурированного документа начинается в дереве документа.
getLockContentControl()	Если установлено значение true, это свойство запрещает пользователю удалять этот структурированный тег документа.
getLockContents()	Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этого тега структурированного документа.
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()
getParentNode()	Получает непосредственного родителя этого узла.
getPlaceholder()	ПолучаетBuildingBlock содержащий текст-заполнитель, который должен отображаться, когда содержимое этого тега структурированного документа пусто, связанный сопоставленный XML-элемент пуст, как указано в параметреgetXmlMapping() элемент илиisShowingPlaceholderText() / isShowingPlaceholderText(boolean) элемент истинный.
getPlaceholderName()	Получает или задает имяBuildingBlock содержащий текст-заполнитель.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getRangeEnd()	Указывает конец диапазона, если StructuredDocumentTag является ранжированным тегом структурированного документа.
getSdtType()	Получает тип этого тега структурированного документа.
getTag()	Указывает тег, связанный с текущим узлом тега структурированного документа.
getText()	Получает текст этого узла и всех его дочерних элементов.
getTitle()	Задает понятное имя, связанное с этим тегом структурированного документа.
getWordOpenXML()	Получает строку, представляющую XML, содержащийся в узле вSaveFormat.FLAT_OPC формат.
getXmlMapping()	Получает объект, представляющий сопоставление этого диапазона тегов структурированного документа с XML-данными в пользовательской XML-части текущего документа.
hashCode()
isComposite()	Возвращает true, если этот узел может содержать другие узлы.
isRanged()
isShowingPlaceholderText()	Указывает, должно ли содержимое этого тега структурированного документа интерпретироваться как текст-заполнитель (в отличие от обычного текстового содержимого в теге структурированного документа).
isShowingPlaceholderText(boolean value)	Указывает, должно ли содержимое этого тега структурированного документа интерпретироваться как текст-заполнитель (в отличие от обычного текстового содержимого в теге структурированного документа).
iterator()	Обеспечивает поддержку для каждой итерации стиля над дочерними узлами этого узла.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
removeAllChildren()	Удаляет все узлы между этим начальным узлом диапазона и конечным узлом диапазона.
removeSelfOnly()	Удаляет это начало диапазона и соответствующие конечные узлы диапазона тега структурированного документа, но сохраняет его содержимое в дереве документа.
setColor(Color value)	Задает цвет тега структурированного документа.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setLockContentControl(boolean value)	Если установлено значение true, это свойство запрещает пользователю удалять этот структурированный тег документа.
setLockContents(boolean value)	Если установлено значение true, это свойство запрещает пользователю редактировать содержимое этого тега структурированного документа.
setPlaceholderName(String value)	Получает или задает имяBuildingBlock содержащий текст-заполнитель.
setTag(String value)	Указывает тег, связанный с текущим узлом тега структурированного документа.
setTitle(String value)	Задает понятное имя, связанное с этим тегом структурированного документа.
structuredDocumentTagNode()
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

StructuredDocumentTagRangeStart(DocumentBase doc, int type)

public StructuredDocumentTagRangeStart(DocumentBase doc, int type)

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

Параметры:

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

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

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

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

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

Параметры:

Параметр	Тип	Описание
visitor	DocumentVisitor

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

appendChild(Node newChild)

public Node appendChild(Node newChild)

Добавляет указанный узел в конец диапазона stdContent.

Параметры:

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

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

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

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

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.

getChildNodes()

public NodeCollection getChildNodes()

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

Возвращает: 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 — цвет тега структурированного документа.

getCustomNodeId()

public int getCustomNodeId()

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

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

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

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

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

getDocument()

public DocumentBase getDocument()

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

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

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

getId()

public int getId()

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

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

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

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

getLastChild()

public Node getLastChild()

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

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

getLevel()

public int getLevel()

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

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

getLockContentControl()

public boolean getLockContentControl()

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

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

getLockContents()

public boolean getLockContents()

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

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

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

Получает тип этого узла.

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

getParentNode()

public CompositeNode getParentNode()

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

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

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

getPlaceholder()

public BuildingBlock getPlaceholder()

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

Возвращает: BuildingBlock -BuildingBlock содержащий текст-заполнитель, который должен отображаться, когда содержимое этого тега структурированного документа пусто, связанный сопоставленный 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 объект, который представляет часть документа, содержащегося в этом узле.

getRangeEnd()

public StructuredDocumentTagRangeEnd getRangeEnd()

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

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

getSdtType()

public int getSdtType()

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

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

getTag()

public String getTag()

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

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

getText()

public String getText()

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

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

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

getTitle()

public String getTitle()

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

Возвращает: 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 текущего документа.

hashCode()

public native int hashCode()

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

isComposite()

public boolean isComposite()

Возвращает true, если этот узел может содержать другие узлы. (31110,6)

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

isRanged()

public boolean isRanged()

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

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

isShowingPlaceholderText()

public boolean isShowingPlaceholderText()

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

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

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

isShowingPlaceholderText(boolean value)

public void isShowingPlaceholderText(boolean value)

Параметры:

Параметр	Тип	Описание
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()

previousPreOrder(Node rootNode)

public Node previousPreOrder(Node rootNode)

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

Параметры:

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

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

remove()

public void remove()

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

removeAllChildren()

public void removeAllChildren()

Удаляет все узлы между этим начальным узлом диапазона и конечным узлом диапазона.

removeSelfOnly()

public void removeSelfOnly()

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

setColor(Color value)

public void setColor(Color value)

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

Параметры:

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

setCustomNodeId(int value)

public void setCustomNodeId(int value)

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

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

Параметры:

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

setLockContentControl(boolean value)

public void setLockContentControl(boolean value)

Параметры:

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

setLockContents(boolean value)

public void setLockContents(boolean value)

Параметры:

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

setPlaceholderName(String value)

public void setPlaceholderName(String value)

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

Параметры:

Параметр	Тип	Описание
value	java.lang.String	Соответствующее значение 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)

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

Параметры:

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

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

StructuredDocumentTagRangeEnd Style