Class Bookmark

إشارة مرجعية

كائن يمثّل إشارة مرجعية 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
var cursor = doc.getCursor();
var bookmark = documentTab.addBookmark(cursor);
Logger.log(bookmark.getId());

الطُرق

الطريقةنوع الإرجاعوصف قصير
getId()Stringالحصول على رقم تعريف Bookmark
getPosition()Positionيحصل على Position من Bookmark ضمن DocumentTab.
remove()voidيؤدي النقر على هذا الزر إلى حذف Bookmark.

الوثائق التفصيلية

getId()

الحصول على رقم تعريف Bookmark ويكون المعرّف فريدًا داخل DocumentTab.

الإرجاع

String — رقم تعريف Bookmark، وهو فريد ضمن DocumentTab.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getPosition()

يحصل على Position من Bookmark ضمن DocumentTab. يظل Position دقيقًا طالما لم يتم حذف Bookmark، حتى إذا كان النص البرمجي تغير هيكل الوثيقة.

الإرجاع

Position — موضع Bookmark

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

remove()

يؤدي النقر على هذا الزر إلى حذف Bookmark. جارٍ استدعاء هذه الطريقة على Bookmark الذي تم استخدامه من قبل حذف لا يكون له أي تأثير.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents