com.aspose.words

Class EditableRangeStart

java.lang.Object

com.aspose.words.Node

com.aspose.words.EditableRangeStart

All Implemented Interfaces:

java.lang.Cloneable

public final class EditableRangeStart
extends Node

Represents a start of an editable range in a Word document.

To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

A complete editable range in a Word document consists of a EditableRangeStart and a matching EditableRangeEnd with the same Id.

EditableRangeStart and EditableRangeEnd are just markers inside a document that specify where the editable range starts and ends.

Use the getEditableRange() class as a "facade" to work with an editable range as a single object.

Currently editable ranges are supported only at the inline-level, that is inside Paragraph, but editable range start and editable range end can be in different paragraphs.

Method Summary

Modifier and Type	Method and Description
boolean	accept(DocumentVisitor visitor) Accepts a visitor.
int	getDisplacedByCustomXml()
EditableRange	getEditableRange() Gets the facade object that encapsulates this editable range start and end.
int	getId() Specifies the identifier of the editable range.
int	getIdInternal()
int	getNodeType() Returns NodeType.EDITABLE_RANGE_START.
int	getParentIdInternal()
void	setDisplacedByCustomXml(int value)
void	setId(int value) Specifies the identifier of the editable range.
void	setIdInternal(int value)
void	setParentIdInternal(int value)

Methods inherited from class com.aspose.words.Node

dd, deepClone, getAncestor, getAncestor, getCustomNodeId, getDocument, getNextSibling, getParentNode, getPreviousSibling, getRange, getText, isComposite, memberwiseClone, nextPreOrder, nodeTypeToString, previousPreOrder, remove, setCustomNodeId, toString, toString, toString, visitorActionToBool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

public final boolean accept(DocumentVisitor visitor)
                     throws java.lang.Exception

Accepts a visitor.

Calls DocumentVisitor.visitEditableRangeStart(com.aspose.words.EditableRangeStart).

For more info see the Visitor design pattern.

Specified by:

accept in class Node

Parameters:

visitor - The visitor that will visit the node.

Returns:

False if the visitor requested the enumeration to stop.

Throws:

java.lang.Exception

getId

public final int getId()

Specifies the identifier of the editable range.

Returns:

The corresponding int value.

setId

public final void setId(int value)

Specifies the identifier of the editable range.

Parameters:

value - The corresponding int value.

getEditableRange

public final EditableRange getEditableRange()

Gets the facade object that encapsulates this editable range start and end.

Returns:

The facade object that encapsulates this editable range start and end.

getNodeType

public final int getNodeType()

Returns NodeType.EDITABLE_RANGE_START.

Specified by:

getNodeType in class Node

Returns:

NodeType.EDITABLE_RANGE_START. The returned value is one of NodeType constants.

getDisplacedByCustomXml

public final int getDisplacedByCustomXml()

setDisplacedByCustomXml

public final void setDisplacedByCustomXml(int value)

getIdInternal

public final int getIdInternal()

setIdInternal

public final void setIdInternal(int value)

getParentIdInternal

public final int getParentIdInternal()

setParentIdInternal

public final void setParentIdInternal(int value)