Class Bookmark

نشانه‌گذاری

یک شیء که نشان دهنده یک نشانه گذاری (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());

روش‌ها

روش نوع بازگشتی شرح مختصر
get Id() String شناسه‌ی Bookmark را دریافت می‌کند.
get Position() Position Position Bookmark را در Document Tab دریافت می‌کند.
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