Bookmark

Bookmark class

يمثل إشارة مرجعية واحدة.

لمعرفة المزيد، قم بزيارةالعمل مع الإشارات المرجعية مقالة توثيقية.

public class Bookmark

الخصائص

اسموصف
BookmarkEnd { get; }يحصل على العقدة التي تمثل نهاية الإشارة المرجعية.
BookmarkStart { get; }يحصل على العقدة التي تمثل بداية الإشارة المرجعية.
FirstColumn { get; }يحصل على الفهرس المبني على الصفر للعمود الأول من نطاق عمود الجدول المرتبط بالإشارة المرجعية.
IsColumn { get; }إرجاعحقيقي إذا كانت هذه الإشارة المرجعية عبارة عن إشارة مرجعية لعمود جدول.
LastColumn { get; }يحصل على الفهرس المبني على الصفر للعمود الأخير من نطاق أعمدة الجدول المرتبط بالإشارة المرجعية.
Name { get; set; }يحصل على اسم الإشارة المرجعية أو يعينه.
Text { get; set; }يحصل على النص الموجود في الإشارة المرجعية أو يعينه.

طُرق

اسموصف
Remove()يزيل الإشارة المرجعية من المستند. لا يزيل النص الموجود داخل الإشارة المرجعية.

ملاحظات

Bookmark هو كائن “واجهة” يغلف عقدتينBookmarkStart وBookmarkEnd في شجرة المستندات وتسمح بالعمل مع الإشارة المرجعية ككائن واحد.

أمثلة

يوضح كيفية إضافة الإشارات المرجعية وتحديث محتوياتها.

public void CreateUpdateAndPrintBookmarks()
{
    // قم بإنشاء مستند يحتوي على ثلاثة إشارات مرجعية، ثم استخدم تنفيذ زائر مستند مخصص لطباعة محتوياتها.
    Document doc = CreateDocumentWithBookmarks(3);
    BookmarkCollection bookmarks = doc.Range.Bookmarks;
    PrintAllBookmarkInfo(bookmarks);

    //يمكن الوصول إلى الإشارات المرجعية في مجموعة الإشارات المرجعية عن طريق الفهرس أو الاسم، ويمكن تحديث أسمائها.
    bookmarks[0].Name = $"{bookmarks[0].Name}_NewName";
    bookmarks["MyBookmark_2"].Text = $"Updated text contents of {bookmarks[1].Name}";

    // اطبع جميع الإشارات المرجعية مرة أخرى لرؤية القيم المحدثة.
    PrintAllBookmarkInfo(bookmarks);
}

/// <summary>
/// إنشاء مستند يحتوي على عدد معين من الإشارات المرجعية.
/// </summary>
private static Document CreateDocumentWithBookmarks(int numberOfBookmarks)
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    for (int i = 1; i <= numberOfBookmarks; i++)
    {
        string bookmarkName = "MyBookmark_" + i;

        builder.Write("Text before bookmark.");
        builder.StartBookmark(bookmarkName);
        builder.Write($"Text inside {bookmarkName}.");
        builder.EndBookmark(bookmarkName);
        builder.Writeln("Text after bookmark.");
    }

    return doc;
}

/// <summary>
/// استخدم متكررًا وزائرًا لطباعة معلومات كل إشارة مرجعية في المجموعة.
/// </summary>
private static void PrintAllBookmarkInfo(BookmarkCollection bookmarks)
{
    BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter();

    //اجعل كل إشارة مرجعية في المجموعة تقبل زائرًا سيقوم بطباعة محتوياتها.
    using (IEnumerator<Bookmark> enumerator = bookmarks.GetEnumerator())
    {
        while (enumerator.MoveNext())
        {
            Bookmark currentBookmark = enumerator.Current;

            if (currentBookmark != null)
            {
                currentBookmark.BookmarkStart.Accept(bookmarkVisitor);
                currentBookmark.BookmarkEnd.Accept(bookmarkVisitor);

                Console.WriteLine(currentBookmark.BookmarkStart.GetText());
            }
        }
    }
}

/// <summary>
/// طباعة محتويات كل إشارة مرجعية تمت زيارتها على وحدة التحكم.
/// </summary>
public class BookmarkInfoPrinter : DocumentVisitor
{
    public override VisitorAction VisitBookmarkStart(BookmarkStart bookmarkStart)
    {
        Console.WriteLine($"BookmarkStart name: \"{bookmarkStart.Name}\", Contents: \"{bookmarkStart.Bookmark.Text}\"");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitBookmarkEnd(BookmarkEnd bookmarkEnd)
    {
        Console.WriteLine($"BookmarkEnd name: \"{bookmarkEnd.Name}\"");
        return VisitorAction.Continue;
    }
}

أنظر أيضا

Body Class BookmarkCollection Class