com.aspose.words

Class EditableRange

java.lang.Object

com.aspose.words.EditableRange

public class EditableRange
extends java.lang.Object

Represents a single editable range.

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

EditableRange is a "facade" object that encapsulates two nodes getEditableRangeStart() and getEditableRangeEnd() in a document tree and allows to work with an editable range as a single object.

Method Summary

Modifier and Type	Method and Description
EditableRangeEnd	getEditableRangeEnd() Gets the node that represents the end of the editable range.
EditableRangeStart	getEditableRangeStart() Gets the node that represents the start of the editable range.
int	getEditorGroup() Gets an alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range.
int	getId() Gets the editable range identifier.
java.lang.String	getSingleUser() Gets the single user for editable range.
void	remove() Removes the editable range from the document.
void	setEditorGroup(int value) Sets an alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range.
void	setSingleUser(java.lang.String value) Sets the single user for editable range.

Methods inherited from class java.lang.Object

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

Method Detail

remove

public void remove()
            throws java.lang.Exception

Removes the editable range from the document. Does not remove content inside the editable range.

Throws:

java.lang.Exception

getId

public int getId()

Gets the editable range identifier.

The region must be demarcated using the getEditableRangeStart() and getEditableRangeEnd()

Editable range identifiers are supposed to be unique across a document and Aspose.Words automatically maintains editable range identifiers when loading, saving and combining documents.

Returns:

The editable range identifier.

getSingleUser

public java.lang.String getSingleUser()

Gets the single user for editable range.

This editor can be stored in one of the following forms:

DOMAIN\Username - for users whose access shall be authenticated using the current user's domain credentials.

user@domain.com - for users whose access shall be authenticated using the user's e-mail address as credentials.

user - for users whose access shall be authenticated using the current user's machine credentials.

Single user and editor group cannot be set simultaneously for the specific editable range, if the one is set, the other will be clear.

Returns:

The single user for editable range.

setSingleUser

public void setSingleUser(java.lang.String value)

Sets the single user for editable range.

This editor can be stored in one of the following forms:

DOMAIN\Username - for users whose access shall be authenticated using the current user's domain credentials.

user@domain.com - for users whose access shall be authenticated using the user's e-mail address as credentials.

user - for users whose access shall be authenticated using the current user's machine credentials.

Single user and editor group cannot be set simultaneously for the specific editable range, if the one is set, the other will be clear.

Parameters:

value - The single user for editable range.

getEditorGroup

public int getEditorGroup()

Gets an alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range.

Single user and editor group cannot be set simultaneously for the specific editable range, if the one is set, the other will be clear.

Returns:

An alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range. The returned value is one of EditorType constants.

setEditorGroup

public void setEditorGroup(int value)

Sets an alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range.

Single user and editor group cannot be set simultaneously for the specific editable range, if the one is set, the other will be clear.

Parameters:

value - An alias (or editing group) which shall be used to determine if the current user shall be allowed to edit this editable range. The value must be one of EditorType constants.

getEditableRangeStart

public EditableRangeStart getEditableRangeStart()

Gets the node that represents the start of the editable range.

Returns:

The node that represents the start of the editable range.

getEditableRangeEnd

public EditableRangeEnd getEditableRangeEnd()
                                     throws java.lang.Exception

Gets the node that represents the end of the editable range.

Returns:

The node that represents the end of the editable range.

Throws:

java.lang.Exception