EditableRangeStart Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents the start of an editable range permission.

• C#
• VB.NET

public sealed class EditableRangeStart : Inline

Public NotInheritable Class EditableRangeStart
    Inherits Inline

Inheritance:

System.Object

Element

Inline

EditableRangeStart

Remarks

EditableRangeStart element is used in a pair with EditableRangeEnd element to mark a region of the document that specific users or groups are allowed to edit when document protection is active.

For EditableRangeStart and EditableRangeEnd to be considered as a pair, their Ids must match.

Constructors

EditableRangeStart(DocumentModel, String)

Initializes a new instance of the EditableRangeStart class.

• C#
• VB.NET

public EditableRangeStart(DocumentModel document, string id)

Public Sub New(document As DocumentModel, id As String)

Parameters

document

DocumentModel

The owner document.

id

System.String

The identifier that pairs this element with a EditableRangeEnd.

Properties

Editor

Gets or sets the single user who is allowed to edit this range.

• C#
• VB.NET

public string Editor { get; set; }

Public Property Editor As String

Property Value

System.String

The user identifier in one of the following forms: DOMAIN\username, user@domain.com, or username. When set, EditorGroup is ignored.

EditorGroup

Gets or sets the predefined group of users who are allowed to edit this range.

• C#
• VB.NET

public EditingGroup EditorGroup { get; set; }

Public Property EditorGroup As EditingGroup

Property Value

EditingGroup

An EditingGroup value. Ignored when Editor is set.

ElementType

Gets the ElementType of this Element instance.

• C#
• VB.NET

public override ElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As ElementType

Property Value

ElementType

The ElementType of this Element instance.

Overrides

Element.ElementType

Id

Gets the identifier that pairs this element with a EditableRangeEnd.

• C#
• VB.NET

public string Id { get; }

Public ReadOnly Property Id As String

Property Value

System.String

Methods

Clone()

Clones this EditableRangeStart instance.

• C#
• VB.NET

public EditableRangeStart Clone()

Public Function Clone As EditableRangeStart

Returns

EditableRangeStart

Cloned EditableRangeStart.

Remarks

Document content element instance can exist only in a one place in the document.

If you want to insert document content element into some other part of the same document, then clone the element and insert its clone.

If you want to insert document content element into another document, then you should first import it into another document with Import<T>(T, Boolean, Boolean) method and then insert the imported element.

For more information, see cloning example.

Inherited Properties

Content	Gets the content of the current Element. (Inherited from Element)
Document	Gets the owner document. (Inherited from Element)
Parent	Gets the parent of this Element instance. (Inherited from Element)
ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline)
Revision	Gets or sets the revision information for the inline. (Inherited from Inline)

Inherited Methods

Clone(System.Boolean)	Clones this Inline instance. (Inherited from Inline)
GetChildElements(System.Boolean)	Gets the child elements. (Inherited from Element)
GetChildElements(System.Boolean, ElementType[])	Gets the child elements filtered by ElementType. (Inherited from Element)
GetParentElements()	Gets the parent elements. (Inherited from Element)
GetParentElements(ElementType[])	Gets the parent elements. (Inherited from Element)

See Also

EditableRangeEnd