end_editable_range method
end_editable_range()
Marks the current position in the document as an editable range end.
def end_editable_range(self):
...
Remarks
Editable range in a document can overlap and span any range. To create a valid editable range you need to call both DocumentBuilder.start_editable_range() and DocumentBuilder.end_editable_range() or DocumentBuilder.end_editable_range() methods.
Badly formed editable range will be ignored when the document is saved.
Returns
The editable range end node that was just created.
end_editable_range(start)
Marks the current position in the document as an editable range end.
def end_editable_range(self, start: aspose.words.EditableRangeStart):
...
| Parameter | Type | Description |
|---|---|---|
| start | EditableRangeStart | This editable range start. |
Remarks
Use this overload during creating nested editable ranges.
Editable range in a document can overlap and span any range. To create a valid editable range you need to call both DocumentBuilder.start_editable_range() and DocumentBuilder.end_editable_range() or DocumentBuilder.end_editable_range() methods.
Badly formed editable range will be ignored when the document is saved.
Returns
The editable range end node that was just created.
Examples
Shows how to create nested editable ranges.
doc = aw.Document()
doc.protect(type=aw.ProtectionType.READ_ONLY, password='MyPassword')
builder = aw.DocumentBuilder(doc=doc)
builder.writeln("Hello world! Since we have set the document's protection level to read-only, " + 'we cannot edit this paragraph without the password.')
# Create two nested editable ranges.
outer_editable_range_start = builder.start_editable_range()
builder.writeln('This paragraph inside the outer editable range and can be edited.')
inner_editable_range_start = builder.start_editable_range()
builder.writeln('This paragraph inside both the outer and inner editable ranges and can be edited.')
# Currently, the document builder's node insertion cursor is in more than one ongoing editable range.
# When we want to end an editable range in this situation,
# we need to specify which of the ranges we wish to end by passing its EditableRangeStart node.
builder.end_editable_range(inner_editable_range_start)
builder.writeln('This paragraph inside the outer editable range and can be edited.')
builder.end_editable_range(outer_editable_range_start)
builder.writeln('This paragraph is outside any editable ranges, and cannot be edited.')
# If a region of text has two overlapping editable ranges with specified groups,
# the combined group of users excluded by both groups are prevented from editing it.
outer_editable_range_start.editable_range.editor_group = aw.EditorType.EVERYONE
inner_editable_range_start.editable_range.editor_group = aw.EditorType.CONTRIBUTORS
doc.save(file_name=ARTIFACTS_DIR + 'EditableRange.Nested.docx')
See Also
- module aspose.words
- class DocumentBuilder