CommentRangeStart

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

public class CommentRangeStart extends Node

Обозначает начало области текста, с которой связан комментарий.

Чтобы узнать больше, посетитеWorking with Comments документальная статья.

Чтобы создать комментарий, привязанный к области текста, необходимо создатьComment а затем создатьCommentRangeStart а такжеCommentRangeEnd и установите их идентификаторы одинаковымиComment.getId() ценность.

CommentRangeStart является узлом встроенного уровня и может быть только потомкомParagraph.

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

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

Методы

Метод	Описание
accept(DocumentVisitor visitor)	Принимает посетителя.
dd()
deepClone(boolean isCloneChildren)	Создает дубликат узла.
equals(Object arg0)
getAncestor(int ancestorType)
getAncestor(Class ancestorType)	Получает первого предка указанного типа объекта.
getClass()
getCustomNodeId()	Задает идентификатор пользовательского узла.
getDisplacedByCustomXml()
getDocument()	Получает документ, которому принадлежит этот узел.
getId()	Указывает идентификатор комментария, с которым связана эта область.
getIdInternal()
getNextSibling()	Получает узел, следующий сразу за этим узлом.
getNodeType()	ВозвращаетNodeType.COMMENT_RANGE_START.
getParentIdInternal()
getParentNode()	Получает непосредственного родителя этого узла.
getPreviousSibling()	Получает узел, непосредственно предшествующий этому узлу.
getRange()	ВозвращаетRange объект, который представляет часть документа, содержащегося в этом узле.
getText()	Получает текст этого узла и всех его дочерних элементов.
hashCode()
isComposite()	Возвращает true, если этот узел может содержать другие узлы.
nextPreOrder(Node rootNode)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
nodeTypeToString(int nodeType)
notify()
notifyAll()
previousPreOrder(Node rootNode)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного порядка.
remove()	Удаляет себя из родителя.
setCustomNodeId(int value)	Задает идентификатор пользовательского узла.
setDisplacedByCustomXml(int value)
setId(int value)	Указывает идентификатор комментария, с которым связана эта область.
setIdInternal(int value)
setParentIdInternal(int value)
toString()
toString(SaveOptions saveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.
toString(int saveFormat)
wait()
wait(long arg0)
wait(long arg0, int arg1)

CommentRangeStart(DocumentBase doc, int id)

public CommentRangeStart(DocumentBase doc, int id)

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

КогдаCommentRangeStart создан, он принадлежит указанному документу, но еще не является его частью иNode.getParentNode() нулевой.

Чтобы добавитьCommentRangeStart к документу используйте InsertAfter или InsertBefore для абзаца, в который вы хотите вставить комментарий.

Параметры:

Параметр	Тип	Описание
doc	DocumentBase	Документ владельца.
id	int	Идентификатор комментария, с которым связан этот объект.

accept(DocumentVisitor visitor)

public boolean accept(DocumentVisitor visitor)

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

ЗвонкиDocumentVisitor.visitCommentRangeStart(com.aspose.words.CommentRangeStart).

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

Параметры:

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

Возвращает: boolean — False, если посетитель запросил остановку перечисления.

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.

getClass()

public final native Class<?> getClass()

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

getCustomNodeId()

public int getCustomNodeId()

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

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

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

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

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

getDisplacedByCustomXml()

public int getDisplacedByCustomXml()

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

getDocument()

public DocumentBase getDocument()

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

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

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

getId()

public int getId()

Указывает идентификатор комментария, с которым связана эта область.

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

getIdInternal()

public int getIdInternal()

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

getNextSibling()

public Node getNextSibling()

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

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

getNodeType()

public int getNodeType()

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

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

getParentIdInternal()

public int getParentIdInternal()

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

getParentNode()

public CompositeNode getParentNode()

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

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

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

getPreviousSibling()

public Node getPreviousSibling()

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

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

getRange()

public Range getRange()

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

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

getText()

public String getText()

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

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

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

hashCode()

public native int hashCode()

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

isComposite()

public boolean isComposite()

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

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

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()

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

setCustomNodeId(int value)

public void setCustomNodeId(int value)

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

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

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

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

Параметры:

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

setDisplacedByCustomXml(int value)

public void setDisplacedByCustomXml(int value)

Параметры:

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

setId(int value)

public void setId(int value)

Указывает идентификатор комментария, с которым связана эта область.

Параметры:

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

setIdInternal(int value)

public void setIdInternal(int value)

Параметры:

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

setParentIdInternal(int value)

public void setParentIdInternal(int value)

Параметры:

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

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