EditableRangeStart

EditableRangeStart class

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

Чтобы узнать больше, посетитеОбъектная модель документа Aspose.Words (DOM) статья документации.

public sealed class EditableRangeStart : Node

Характеристики

Имя	Описание
CustomNodeId { get; set; }	Указывает пользовательский идентификатор узла.
virtual Document { get; }	Получает документ, которому принадлежит этот узел.
EditableRange { get; }	Получает объект фасада, который инкапсулирует начало и конец этого редактируемого диапазона.
Id { get; set; }	Указывает идентификатор редактируемого диапазона.
virtual IsComposite { get; }	Возвращает`истинный` если этот узел может содержать другие узлы.
NextSibling { get; }	Получает узел, следующий сразу за этим узлом.
override NodeType { get; }	ВозвращаетEditableRangeStart .
ParentNode { get; }	Получает непосредственного родителя этого узла.
PreviousSibling { get; }	Получает узел, непосредственно предшествующий этому узлу.
Range { get; }	Возвращает`Range` объект, представляющий часть документа, содержащуюся в этом узле.

Методы

Имя	Описание
override Accept(DocumentVisitor)	Принимает посетителя.
Clone(bool)	Создает дубликат узла.
GetAncestor(NodeType)	Получает первого предка указанного`NodeType` .
GetAncestor(Type)	Получает первого предка указанного типа объекта.
virtual GetText()	Получает текст этого узла и всех его дочерних элементов.
NextPreOrder(Node)	Получает следующий узел в соответствии с алгоритмом обхода дерева предварительного заказа.
PreviousPreOrder(Node)	Получает предыдущий узел в соответствии с алгоритмом обхода дерева предварительного заказа.
Remove()	Удаляет себя от родителя.
ToString(SaveFormat)	Экспортирует содержимое узла в строку указанного формата.
ToString(SaveOptions)	Экспортирует содержимое узла в строку, используя указанные параметры сохранения.

Примечания

Полный редактируемый диапазон в документе Word состоит изEditableRangeStart и соответствиеEditableRangeEnd с тем же идентификатором.

EditableRangeStart иEditableRangeEnd это просто маркеры внутри document , которые указывают, где начинается и заканчивается редактируемый диапазон.

ИспользоватьEditableRange класс как «фасад» для работы с редактируемым диапазоном как с одним объектом.

В настоящее время редактируемые диапазоны поддерживаются только на линейном уровне, то есть внутриParagraph, но начало редактируемого диапазона и конец редактируемого диапазона могут находиться в разных абзацах.

Примеры

Показывает, как ограничить права редактирования редактируемых диапазонов определенной группой/пользователем.

public void Visitor()
{
    Document doc = new Document();
    doc.Protect(ProtectionType.ReadOnly, "MyPassword");

    DocumentBuilder builder = new DocumentBuilder(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.");

    // Когда мы защищаем документы от записи, редактируемые диапазоны позволяют нам выбирать определенные области, которые пользователи могут редактировать.
    // Есть два взаимоисключающих способа сузить список разрешенных редакторов.
    // 1 - Указываем пользователя:
    EditableRange editableRange = builder.StartEditableRange().EditableRange;
    editableRange.SingleUser = "john.doe@myoffice.com";
    builder.Writeln($"This paragraph is inside the first editable range, can only be edited by {editableRange.SingleUser}.");
    builder.EndEditableRange();

    Assert.AreEqual(EditorType.Unspecified, editableRange.EditorGroup);

    // 2 - Укажите группу, с которой связаны разрешенные пользователи:
    editableRange = builder.StartEditableRange().EditableRange;
    editableRange.EditorGroup = EditorType.Administrators;
    builder.Writeln($"This paragraph is inside the first editable range, can only be edited by {editableRange.EditorGroup}.");
    builder.EndEditableRange();

    Assert.AreEqual(string.Empty, editableRange.SingleUser);

    builder.Writeln("This paragraph is outside the editable range, and cannot be edited by anybody.");

    // Распечатываем детали и содержимое каждого редактируемого диапазона в документе.
    EditableRangePrinter editableRangePrinter = new EditableRangePrinter();

    doc.Accept(editableRangePrinter);

    Console.WriteLine(editableRangePrinter.ToText());
}

/// <summary>
/// Собирает свойства и содержимое посещенных редактируемых диапазонов в строку.
/// </summary>
public class EditableRangePrinter : DocumentVisitor
{
    public EditableRangePrinter()
    {
        mBuilder = new StringBuilder();
    }

    public string ToText()
    {
        return mBuilder.ToString();
    }

    public void Reset()
    {
        mBuilder.Clear();
        mInsideEditableRange = false;
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел EditableRangeStart.
    /// </summary>
    public override VisitorAction VisitEditableRangeStart(EditableRangeStart editableRangeStart)
    {
        mBuilder.AppendLine(" -- Editable range found! -- ");
        mBuilder.AppendLine("\tID:\t\t" + editableRangeStart.Id);
        if (editableRangeStart.EditableRange.SingleUser == string.Empty)
            mBuilder.AppendLine("\tGroup:\t" + editableRangeStart.EditableRange.EditorGroup);
        else
            mBuilder.AppendLine("\tUser:\t" + editableRangeStart.EditableRange.SingleUser);
        mBuilder.AppendLine("\tContents:");

        mInsideEditableRange = true;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел EditableRangeEnd.
    /// </summary>
    public override VisitorAction VisitEditableRangeEnd(EditableRangeEnd editableRangeEnd)
    {
        mBuilder.AppendLine(" -- End of editable range --\n");

        mInsideEditableRange = false;

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел Run. Этот посетитель записывает только прогоны, находящиеся в пределах редактируемых диапазонов.
    /// </summary>
    public override VisitorAction VisitRun(Run run)
    {
        if (mInsideEditableRange) mBuilder.AppendLine("\t\"" + run.Text + "\"");

        return VisitorAction.Continue;
    }

    private bool mInsideEditableRange;
    private readonly StringBuilder mBuilder;
}

Смотрите также

class Node
пространство имен Aspose.Words
сборка Aspose.Words

EditableRangeEnd Class EditorType Enum