FieldStart

FieldStart class

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

public class FieldStart : FieldChar

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

Имя Описание
CustomNodeId { get; set; } Указывает идентификатор пользовательского узла.
virtual Document { get; } Получает документ, которому принадлежит этот узел.
FieldData { get; } Получает данные пользовательского поля, связанные с полем.
FieldType { get; } Возвращает тип поля.
Font { get; } Предоставляет доступ к форматированию шрифта этого объекта.
virtual IsComposite { get; } Возвращает true, если этот узел может содержать другие узлы.
IsDeleteRevision { get; } Возвращает значение true, если этот объект был удален в Microsoft Word при включенном отслеживании изменений.
IsDirty { get; set; } Получает или устанавливает, является ли текущий результат поля более неправильным (устаревшим) из-за других изменений , внесенных в документ.
IsFormatRevision { get; } Возвращает значение true, если форматирование объекта было изменено в Microsoft Word при включенном отслеживании изменений.
IsInsertRevision { get; } Возвращает значение true, если этот объект был вставлен в Microsoft Word при включенном отслеживании изменений.
IsLocked { get; set; } Получает или задает, заблокировано ли родительское поле (не следует пересчитывать его результат).
IsMoveFromRevision { get; } Возвращает истинный если этот объект был перемещен (удален) в Microsoft Word при включенном отслеживании изменений.
IsMoveToRevision { get; } Возвращает истинный если этот объект был перемещен (вставлен) в Microsoft Word при включенном отслеживании изменений.
NextSibling { get; } Получает узел, следующий сразу за этим узлом.
override NodeType { get; } ВозвращаетFieldStart .
ParentNode { get; } Получает непосредственного родителя этого узла.
ParentParagraph { get; } Извлекает родителяParagraph этого узла.
PreviousSibling { get; } Получает узел, непосредственно предшествующий этому узлу.
Range { get; } Возвращает Диапазон объект, представляющий часть документа, содержащегося в этом узле.

Методы

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

Примечания

FieldStart является узлом встроенного уровня и представлен как the FieldStartChar управляющий символ в документе.

FieldStart может быть только ребенкомParagraph.

Полное поле в документе Microsoft Word представляет собой сложную структуру, состоящую из начального символа поля, кода поля, символа-разделителя поля, результата поля и конечного символа поля. Некоторые поля имеют только начало поля, код поля и конец поля.

Чтобы легко вставить новое поле в документ, используйтеInsertField метод.

Примеры

Показывает, как работать с коллекцией полей.

{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.InsertField(" DATE \\@ \"dddd, d MMMM yyyy\" ");
    builder.InsertField(" TIME ");
    builder.InsertField(" REVNUM ");
    builder.InsertField(" AUTHOR  \"John Doe\" ");
    builder.InsertField(" SUBJECT \"My Subject\" ");
    builder.InsertField(" QUOTE \"Hello world!\" ");
    doc.UpdateFields();

    FieldCollection fields = doc.Range.Fields;

    Assert.AreEqual(6, fields.Count);

    // Перебираем коллекцию полей и печатаем содержимое и тип
    // каждого поля с использованием пользовательской реализации посетителя.
    FieldVisitor fieldVisitor = new FieldVisitor();

    using (IEnumerator<Field> fieldEnumerator = fields.GetEnumerator())
    {
        while (fieldEnumerator.MoveNext())
        {
            if (fieldEnumerator.Current != null)
            {
                fieldEnumerator.Current.Start.Accept(fieldVisitor);
                fieldEnumerator.Current.Separator?.Accept(fieldVisitor);
                fieldEnumerator.Current.End.Accept(fieldVisitor);
            }
            else
            {
                Console.WriteLine("There are no fields in the document.");
            }
        }
    }

    Console.WriteLine(fieldVisitor.GetText());

/// <summary>
/// Реализация посетителя документа, которая печатает информацию о поле.
/// </summary>
public class FieldVisitor : DocumentVisitor
{
    public FieldVisitor()
    {
        mBuilder = new StringBuilder();
    }

    /// <summary>
    /// Получает обычный текст документа, который накопил посетитель.
    /// </summary>
    public string GetText()
    {
        return mBuilder.ToString();
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел FieldStart.
    /// </summary>
    public override VisitorAction VisitFieldStart(FieldStart fieldStart)
    {
        mBuilder.AppendLine("Found field: " + fieldStart.FieldType);
        mBuilder.AppendLine("\tField code: " + fieldStart.GetField().GetFieldCode());
        mBuilder.AppendLine("\tDisplayed as: " + fieldStart.GetField().Result);

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел FieldSeparator.
    /// </summary>
    public override VisitorAction VisitFieldSeparator(FieldSeparator fieldSeparator)
    {
        mBuilder.AppendLine("\tFound separator: " + fieldSeparator.GetText());

        return VisitorAction.Continue;
    }

    /// <summary>
    /// Вызывается, когда в документе встречается узел FieldEnd.
    /// </summary>
    public override VisitorAction VisitFieldEnd(FieldEnd fieldEnd)
    {
        mBuilder.AppendLine("End of field: " + fieldEnd.FieldType);

        return VisitorAction.Continue;
    }

    private readonly StringBuilder mBuilder;
}

Показывает, как найти все гиперссылки в документе Word, а затем изменить их URL-адреса и отображаемые имена.

using System;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using Aspose.Words;
using Aspose.Words.Fields;
using NUnit.Framework;

namespace ApiExamples
{
    public class ExReplaceHyperlinks : ApiExampleBase
    {
        public void Fields()
        {
            Document doc = new Document(MyDir + "Hyperlinks.docx");

            // Гиперссылки в документах Word являются полями. Чтобы начать поиск гиперссылок, мы должны сначала найти все поля.
            // Используйте метод "SelectNodes", чтобы найти все поля в документе через XPath.
            NodeList fieldStarts = doc.SelectNodes("//Начало поля");

            foreach (FieldStart fieldStart in fieldStarts.OfType<FieldStart>())
            {
                if (fieldStart.FieldType == FieldType.FieldHyperlink)
                {
                    Hyperlink hyperlink = new Hyperlink(fieldStart);

                    // Гиперссылки на закладки не имеют URL.
                    if (hyperlink.IsLocal)
                        continue;

                    // Дайте каждой URL-гиперссылке новый URL-адрес и имя.
                    hyperlink.Target = NewUrl;
                    hyperlink.Name = NewName;
                }
            }

            doc.Save(ArtifactsDir + "ReplaceHyperlinks.Fields.docx");
        }

        private const string NewUrl = @"http://www.aspose.com";
        private const string NewName = "Aspose - The .NET & Java Component Publisher";
    }

    /// <summary>
    /// Поля HYPERLINK содержат и отображают гиперссылки в теле документа. Поле в Aspose.Words 
    /// состоит из нескольких узлов, и работать со всеми этими узлами напрямую может быть сложно. 
    /// Эта реализация будет работать, только если код и имя гиперссылки состоят только из одного узла Run.
    ///
    /// Структура узла для полей следующая:
    /// 
    /// [FieldStart][Выполнить - код поля][FieldSeparator][Выполнить - результат поля][FieldEnd]
    /// 
    /// Ниже приведены два примера кодов полей HYPERLINK:
    /// ГИПЕРССЫЛКА "url"
    /// ГИПЕРССЫЛКА \l "имя закладки"
    /// 
    /// Свойство «Результат» поля содержит текст, который поле отображает пользователю в теле документа.
    /// </summary>
    internal class Hyperlink
    {
        internal Hyperlink(FieldStart fieldStart)
        {
            if (fieldStart == null)
                throw new ArgumentNullException("fieldStart");
            if (fieldStart.FieldType != FieldType.FieldHyperlink)
                throw new ArgumentException("Field start type must be FieldHyperlink.");

            mFieldStart = fieldStart;

            // Находим узел-разделитель полей.
            mFieldSeparator = FindNextSibling(mFieldStart, NodeType.FieldSeparator);
            if (mFieldSeparator == null)
                throw new InvalidOperationException("Cannot find field separator.");

            // Обычно мы всегда можем найти конечный узел поля, но пример документа 
            // содержит разрыв абзаца внутри гиперссылки, который ставит конец поля 
            // в следующем абзаце. Будет намного сложнее обрабатывать поля, которые охватывают несколько 
            // абзацы правильно. В этом случае достаточно, чтобы конец поля был нулевым.
            mFieldEnd = FindNextSibling(mFieldSeparator, NodeType.FieldEnd);

            // Код поля выглядит примерно так: "ГИПЕРССЫЛКА "http:\\www.myurl.com"", но может состоять из нескольких прогонов.
            string fieldCode = GetTextSameParent(mFieldStart.NextSibling, mFieldSeparator);
            Match match = gRegex.Match(fieldCode.Trim());

            // Гиперссылка является локальной, если в коде поля присутствует \l.
            mIsLocal = match.Groups[1].Length > 0; 
            mTarget = match.Groups[2].Value;
        }

        /// <summary>
        /// Получает или задает отображаемое имя гиперссылки.
        /// </summary>
        internal string Name
        {
            get => GetTextSameParent(mFieldSeparator, mFieldEnd); 
            set
            {
                // Отображаемое имя гиперссылки сохраняется в поле result, которое является Run 
                // узел между разделителем полей и концом поля.
                Run fieldResult = (Run) mFieldSeparator.NextSibling;
                fieldResult.Text = value;

                // Если результат поля состоит из более чем одного прогона, удаляем эти прогоны.
                RemoveSameParent(fieldResult.NextSibling, mFieldEnd);
            }
        }

        /// <summary>
        /// Получает или задает целевой URL или имя закладки гиперссылки.
        /// </summary>
        internal string Target
        {
            get => mTarget;
            set
            {
                mTarget = value;
                UpdateFieldCode();
            }
        }

        /// <summary>
        /// Истинно, если целью гиперссылки является закладка внутри документа. False, если гиперссылка является URL-адресом.
        /// </summary>
        internal bool IsLocal
        {
            get => mIsLocal; 
            set
            {
                mIsLocal = value;
                UpdateFieldCode();
            }
        }

        private void UpdateFieldCode()
        {
            // Код поля поля находится в узле Run между начальным узлом поля и разделителем полей.
            Run fieldCode = (Run) mFieldStart.NextSibling;
            fieldCode.Text = string.Format("HYPERLINK {0}\"{1}\"", ((mIsLocal) ? "\\l " : ""), mTarget);

            // Если код поля состоит из нескольких прогонов, удалите эти прогоны.
            RemoveSameParent(fieldCode.NextSibling, mFieldSeparator);
        }

        /// <summary>
        /// Проходит через братьев и сестер, начиная с начального узла, пока не найдет узел указанного типа или null.
        /// </summary>
        private static Node FindNextSibling(Node startNode, NodeType nodeType)
        {
            for (Node node = startNode; node != null; node = node.NextSibling)
            {
                if (node.NodeType == nodeType)
                    return node;
            }

            return null;
        }

        /// <summary>
        /// Получает текст от начала до конечного узла, но не включая его.
        /// </summary>
        private static string GetTextSameParent(Node startNode, Node endNode)
        {
            if ((endNode != null) && (startNode.ParentNode != endNode.ParentNode))
                throw new ArgumentException("Start and end nodes are expected to have the same parent.");

            StringBuilder builder = new StringBuilder();
            for (Node child = startNode; !child.Equals(endNode); child = child.NextSibling)
                builder.Append(child.GetText());

            return builder.ToString();
        }

        /// <summary>
        /// Удаляет узлы от начального до конечного узла, но не включая его.
        /// Предполагается, что начальный и конечный узлы имеют одного родителя.
        /// </summary>
        private static void RemoveSameParent(Node startNode, Node endNode)
        {
            if (endNode != null && startNode.ParentNode != endNode.ParentNode)
                throw new ArgumentException("Start and end nodes are expected to have the same parent.");

            Node curChild = startNode;
            while ((curChild != null) && (curChild != endNode))
            {
                Node nextChild = curChild.NextSibling;
                curChild.Remove();
                curChild = nextChild;
            }
        }

        private readonly Node mFieldStart;
        private readonly Node mFieldSeparator;
        private readonly Node mFieldEnd;
        private bool mIsLocal;
        private string mTarget;

        private static readonly Regex gRegex = new Regex(
            "\\S+" + // Одна или несколько ГИПЕРССЫЛОК без пробелов или других слов на других языках.
            "\\s+" + // Один или несколько пробелов.
            "(?:\"\"\\s+)?" + // Незахватывающий необязательный "" и один или несколько пробелов.
            "(\\\\l\\s+)?" + // Необязательный флаг \l, за которым следует один или несколько пробелов.
            "\"" + // Один апостроф.    
            "([^\"]+)" + // Один или несколько символов, кроме апострофа (цель гиперссылки).
            "\"" // Один закрывающий апостроф.
        );
    }
}

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