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