Class Bookmark

وضع إشارة

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

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

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
const cursor = doc.getCursor();
const 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