Class Document

سند

یک سند، حاوی یک یا چند شی Tab ، که هر کدام حاوی متن غنی و عناصری مانند جداول و لیست است.

ممکن است اسناد با استفاده از Document App باز یا ایجاد شوند.

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

روش‌هایی در کلاس Document که مستقیماً به محتوای متن دسترسی پیدا می‌کنند و آن‌ها را تغییر می‌دهند، بر روی برگه فعال (در اسکریپت‌های متصل به یک سند خاص) یا تب اول (اگر یک برگه فعال در دسترس نباشد) عمل می‌کنند. اسکریپت های متکی به این روش ها (به عنوان مثال، get Body() ) را می توان با استفاده از get Tabs() و سپس Tab.asDocumentTab() به برگه ها پشتیبانی کرد.

روش ها

روش نوع برگشت شرح مختصر
add Bookmark(position) Bookmark یک Bookmark در Position داده شده به برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
add Editor(emailAddress) Document کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند.
add Editor(user) Document کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند.
add Editors(emailAddresses) Document آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند.
add Footer() Footer Section یک بخش پاورقی، اگر وجود نداشته باشد، به اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
add Header() Header Section یک بخش سرصفحه، اگر وجود نداشته باشد، به اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند.
add Named Range(name, range) Named Range یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه‌ای است که برای بازیابی بعدی، در برگه اول یا برای اسکریپت‌هایی که به یک سند متصل هستند، در برگه فعال استفاده می‌کند.
add Viewer(emailAddress) Document کاربر داده شده را به لیست بینندگان Document اضافه می کند.
add Viewer(user) Document کاربر داده شده را به لیست بینندگان Document اضافه می کند.
add Viewers(emailAddresses) Document آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند.
get Active Tab() Tab Tab فعال فعلی کاربر را در سند دریافت می کند.
get As(contentType) Blob محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند.
get Blob() Blob محتویات Document فعلی را به صورت لکه ای بازیابی می کند.
get Body() Body Body اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، Document Body Section برگه فعال را بازیابی می کند.
get Bookmark(id) Bookmark Bookmark را با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
get Bookmarks() Bookmark[] همه اشیاء Bookmark را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
get Cursor() Position نشانگر کاربر را در برگه فعال دریافت می کند.
get Editors() User[] لیست ویرایشگران این Document را دریافت می کند.
get Footer() Footer Section بخش پاورقی برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش پاورقی برگه فعال را بازیابی می کند.
get Footnotes() Footnote[] تمام عناصر Footnote را در بدنه اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، بدنه برگه فعال را بازیابی می کند.
get Header() Header Section بخش هدر برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش سربرگ برگه فعال را بازیابی می کند.
get Id() String شناسه منحصر به فرد سند را بازیابی می کند.
get Language() String کد زبان سند را دریافت می کند.
get Name() String عنوان سند را بازیابی می کند.
get Named Range By Id(id) Named Range Named Range با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
get Named Ranges() Named Range[] تمام اشیاء Named Range را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
get Named Ranges(name) Named Range[] همه اشیای Named Range با نام داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند.
get Selection() Range انتخاب کاربر را در برگه فعال دریافت می کند.
get Supported Language Codes() String[] همه کدهای زبانی که در فایل‌های Google Docs پشتیبانی می‌شوند را دریافت می‌کند.
get Tab(tabId) Tab Tab را با شناسه مشخص شده دریافت می کند.
get Tabs() Tab[] همه Tab های تودرتو نشده را که بخشی از سند هستند دریافت می کند.
get Url() String URL را برای دسترسی به سند فعلی بازیابی می کند.
get Viewers() User[] لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند.
new Position(element, offset) Position یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص در برگه اول یا، برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال است.
new Range() Range Builder سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه در اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، از برگه فعال استفاده می شود.
remove Editor(emailAddress) Document کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند.
remove Editor(user) Document کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند.
remove Viewer(emailAddress) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند.
remove Viewer(user) Document کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند.
save And Close() void Document فعلی را ذخیره می کند.
set Active Tab(tabId) void Tab انتخاب شده کاربر در سند فعلی را به برگه با شناسه مشخص شده تنظیم می کند.
set Cursor(position) Document مکان نما کاربر را با یک Position تعیین می کند.
set Language(languageCode) Document کد زبان سند را تنظیم می کند.
set Name(name) Document عنوان سند را تنظیم می کند.
set Selection(range) Document انتخاب کاربر را در برگه فعال با توجه به Range تنظیم می کند.

مستندات دقیق

add Bookmark(position)

یک Bookmark در Position داده شده به برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن نشانک به هر برگه، از روش Document Tab.addBookmark(position) استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

پارامترها

نام تایپ کنید توضیحات
position Position موقعیت نشانک جدید.

بازگشت

Bookmark - نشانک جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Editor(emailAddress)

کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای افزودن

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Editor(user)

کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Editors(emailAddresses)

آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
email Addresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Footer()

یک بخش پاورقی، اگر وجود نداشته باشد، به اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن بخش پاورقی به هر برگه، از متد Document Tab.addFooter() استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

بازگشت

Footer Section - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Header()

یک بخش سرصفحه، اگر وجود نداشته باشد، به اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، به برگه فعال اضافه می کند. برای افزودن یک بخش هدر به هر تب، از متد Document Tab.addHeader() استفاده کنید.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

بازگشت

Header Section - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Named Range(name, range)

یک Named Range اضافه می‌کند، که Range است که دارای نام و شناسه‌ای است که برای بازیابی بعدی، در برگه اول یا برای اسکریپت‌هایی که به یک سند متصل هستند، در برگه فعال استفاده می‌کند. برای افزودن یک Named Range در هر برگه، از روش Document Tab.addNamedRange(name, range) استفاده کنید. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک سند می توانند یک نام مشترک داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها در سند منحصر به فرد هستند، مانند شناسه در HTML. بعد از اینکه یک Named Range به یک سند اضافه کردید، نمی توانید آن را تغییر دهید، فقط می توانید آن را حذف کنید.

هر اسکریپتی که به سند دسترسی داشته باشد می تواند به یک Named Range دسترسی داشته باشد. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لازم نیست منحصر به فرد باشد. نام محدوده باید بین 1 تا 256 کاراکتر باشد.
range Range محدوده عناصری که باید با نام مرتبط شوند. محدوده می تواند انتخاب فعال ، یک نتیجه جستجو ، یا به صورت دستی با new Range() ساخته شود.

بازگشت

Named Range - Named Range .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Viewer(emailAddress)

کاربر داده شده را به لیست بینندگان Document اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای افزودن

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Viewer(user)

کاربر داده شده را به لیست بینندگان Document اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

add Viewers(emailAddresses)

آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
email Addresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Active Tab()

Tab فعال فعلی کاربر را در سند دریافت می کند. یک اسکریپت فقط می‌تواند به برگه فعال کاربری که اسکریپت را اجرا می‌کند دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل شده باشد.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

بازگشت

Tab - Tab فعال کاربر در حال حاضر، یا اگر اسکریپت به سند محدود نشده باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get As(contentType)

محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

پارامترها

نام تایپ کنید توضیحات
content Type String نوع MIME برای تبدیل؛ 'application/pdf' و 'text/markdown' پشتیبانی می شوند.

بازگشت

Blob - سند فعلی به عنوان یک لکه.

get Blob()

محتویات Document فعلی را به صورت لکه ای بازیابی می کند.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

بازگشت

Blob - سند فعلی به عنوان یک لکه.

get Body()

Body اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، Document Body Section برگه فعال را بازیابی می کند. برای دریافت Document Body Section هر برگه، از متد Document Tab.getBody() استفاده کنید.

برگه ها ممکن است شامل انواع مختلفی از بخش ها باشند (به عنوان مثال، Header Section ، Footer Section ). بخش فعال یک برگه Body است.

روش های عنصر در Document به Body فعال تفویض می شود.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

بازگشت

Body - بخش بدنه زبانه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Bookmark(id)

Bookmark را با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت نشانک در هر برگه، از روش Document Tab.getBookmark(id) استفاده کنید. اگر چنین Bookmark در برگه وجود نداشته باشد، این روش null را برمی‌گرداند. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

پارامترها

نام تایپ کنید توضیحات
id String شناسه Bookmark .

بازگشت

Bookmark - Bookmark با شناسه داده شده، یا اگر چنین Bookmark در برگه وجود نداشته باشد null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Bookmarks()

همه اشیاء Bookmark را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت همه نشانک ها در هر برگه، از روش Document Tab.getBookmarks() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

بازگشت

Bookmark[] - آرایه ای از اشیاء Bookmark در برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Cursor()

نشانگر کاربر را در برگه فعال دریافت می کند. یک اسکریپت فقط می‌تواند به مکان‌نمای کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

بازگشت

Position - نمایشی از مکان نما کاربر، یا اگر کاربر مکان نما را در برگه قرار ندهد یا اسکریپت به سند محدود نشده باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Editors()

لیست ویرایشگران این Document را دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز ویرایش.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Footer()

بخش پاورقی برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش پاورقی برگه فعال را بازیابی می کند. برای دریافت بخش فوتر هر برگه، از متد Document Tab.getFooter() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

بازگشت

Footer Section - پاورقی برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Footnotes()

تمام عناصر Footnote را در بدنه اولین برگه یا برای اسکریپت هایی که به یک سند متصل هستند، بدنه برگه فعال را بازیابی می کند. برای دریافت تمام پاورقی ها در هر برگه، از متد Document Tab.getFootnotes() استفاده کنید.

تماس‌های get Footnotes باعث تکرار در عناصر برگه می‌شوند. برای برگه های بزرگ، از تماس های غیر ضروری به این روش خودداری کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

بازگشت

Footnote[] - پاورقی های برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Header()

بخش هدر برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، بخش سربرگ برگه فعال را بازیابی می کند. برای دریافت قسمت سربرگ هر برگه، از متد Document Tab.getHeader() استفاده کنید. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

بازگشت

Header Section - سربرگ برگه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Id()

شناسه منحصر به فرد سند را بازیابی می کند. شناسه سند با Document App.openById() برای باز کردن یک نمونه سند خاص استفاده می شود.

بازگشت

String - شناسه سند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Language()

کد زبان سند را دریافت می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد.

بازگشت

String - زبان سند، یا اگر تعریف نشده باشد null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Name()

عنوان سند را بازیابی می کند.

بازگشت

String - عنوان سند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Named Range By Id(id)

Named Range با شناسه داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت Named Range با شناسه داده شده در هر برگه، از روش Document Tab.getNamedRangeById(id) استفاده کنید. این متد اگر Named Range در برگه وجود نداشته باشد، null برمی گرداند. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک برگه ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

پارامترها

نام تایپ کنید توضیحات
id String شناسه محدوده، که در برگه منحصر به فرد است.

بازگشت

Named Range - Named Range با شناسه داده شده، یا اگر چنین محدوده‌ای در برگه وجود نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Named Ranges()

تمام اشیاء Named Range را در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت تمام اشیاء Named Range در هر برگه، از متد Document Tab.getNamedRanges() استفاده کنید.

یک Named Range توسط هر اسکریپتی که به برگه دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

بازگشت

Named Range[] - آرایه ای از اشیاء Named Range در برگه، احتمالاً شامل چندین محدوده با یک نام است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Named Ranges(name)

همه اشیای Named Range با نام داده شده در برگه اول یا برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال را دریافت می کند. برای دریافت تمام اشیای Named Range در هر برگه، از روش Document Tab.getNamedRanges(name) استفاده کنید. نام‌ها لزوماً منحصر به فرد نیستند، حتی در سربرگ‌ها. چندین محدوده مختلف در یک برگه ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسه‌ها مانند شناسه در HTML منحصربه‌فرد هستند.

یک Named Range توسط هر اسکریپتی که به سند دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده، که لزوما منحصر به فرد نیست.

بازگشت

Named Range[] - آرایه ای از اشیاء Named Range در برگه با نام داده شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Selection()

انتخاب کاربر را در برگه فعال دریافت می کند. یک اسکریپت فقط می‌تواند به انتخاب کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

بازگشت

Range - نمایشی از انتخاب کاربر، null اگر کاربر چیزی را در برگه انتخاب نکرده باشد، اگر فقط انتهای یک پاراگراف انتخاب شده باشد، اگر فقط انتهای یک پاراگراف و یک خط جدید انتخاب شده باشد، یا اگر اسکریپت به سند محدود نمی شود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Supported Language Codes()

همه کدهای زبانی که در فایل‌های Google Docs پشتیبانی می‌شوند را دریافت می‌کند.

بازگشت

String[] - آرایه ای از کدهای زبان.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Tab(tabId)

Tab را با شناسه مشخص شده دریافت می کند. اگر چنین Tab وجود نداشته باشد، این متد null را برمی‌گرداند. می تواند به برگه ها در هر سطح تودرتو دسترسی داشته باشد.

پارامترها

نام تایپ کنید توضیحات
tab Id String شناسه برگه برای دریافت.

بازگشت

Tab - Tab با شناسه مشخص شده، یا اگر چنین Tab وجود نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Tabs()

همه Tab های تودرتو نشده را که بخشی از سند هستند دریافت می کند.

برگه‌ها می‌توانند حاوی برگه‌های فرزند باشند، یک برگه تودرتو در یک برگه دیگر. برگه های فرزند با استفاده از Tab.getChildTabs() قابل دسترسی هستند.

بازگشت

Tab[] - لیست تمام Tab هایی که بخشی از سند هستند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Url()

URL را برای دسترسی به سند فعلی بازیابی می کند. 

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

بازگشت

String - URL برای دسترسی به سند فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

get Viewers()

لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز مشاهده یا نظر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

new Position(element, offset)

یک Position جدید ایجاد می کند، که اشاره ای به یک مکان در برگه، نسبت به یک عنصر خاص در برگه اول یا، برای اسکریپت هایی که به یک سند متصل هستند، برگه فعال است. برای ایجاد یک Position نسبت به یک مکان در هر برگه، از روش Document Tab.newPosition(element, offset) استفاده کنید. مکان‌نمای کاربر در میان سایر کاربردها به‌عنوان یک Position نمایش داده می‌شود. 

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

پارامترها

نام تایپ کنید توضیحات
element Element عنصری که باید حاوی Position جدید باشد. این باید یا یک عنصر Text یا یک عنصر ظرف مانند Paragraph باشد.
offset Integer برای عناصر Text ، تعداد کاراکترهای قبل از Position . برای سایر عناصر، تعداد عناصر فرزند قبل از Position در همان عنصر ظرف.

بازگشت

Position - Position جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

new Range()

سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر برگه در اولین تب یا برای اسکریپت هایی که به یک سند متصل هستند، از برگه فعال استفاده می شود. برای ایجاد یک سازنده مورد استفاده برای ساخت اشیاء Document Range از عناصر برگه در هر برگه، از متد Document Tab.newRange() استفاده کنید. 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

بازگشت

Range Builder - سازنده جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove Editor(emailAddress)

کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document را مسدود نمی‌کند - برای مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove Editor(user)

کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document را مسدود نمی‌کند - برای مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای حذف.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove Viewer(emailAddress)

کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده یا نظر دهنده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document را مسدود نمی‌کند - به عنوان مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Document - این Document برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

remove Viewer(user)

کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document را مسدود نمی‌کند - به عنوان مثال، اگر Document با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای حذف.

بازگشت

Document - این Document برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

save And Close()

Document فعلی را ذخیره می کند. باعث می شود که به روز رسانی های معلق پاک و اعمال شوند.

متد save And Close() به طور خودکار در پایان اجرای اسکریپت برای هر Document قابل ویرایش باز فراخوانی می شود.

یک Document بسته قابل ویرایش نیست. از Document App.openById() برای باز کردن مجدد یک سند معین برای ویرایش استفاده کنید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

set Active Tab(tabId)

Tab انتخاب شده کاربر در سند فعلی را به برگه با شناسه مشخص شده تنظیم می کند. 

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

پارامترها

نام تایپ کنید توضیحات
tab Id String شناسه برگه برای تنظیم به عنوان فعال.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

set Cursor(position)

مکان نما کاربر را با یک Position تعیین می کند. یک اسکریپت فقط می‌تواند به مکان‌نمای کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.

ارائه یک Position از یک Tab غیرفعال، برگه فعال کاربر را تغییر می دهد. 

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

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

پارامترها

نام تایپ کنید توضیحات
position Position مکان مکان نما جدید

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

set Language(languageCode)

کد زبان سند را تنظیم می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد. get Supported Language Codes() برای دریافت همه کدهای زبان معتبر استفاده کنید.

پارامترها

نام تایپ کنید توضیحات
language Code String کد زبان

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

set Name(name)

عنوان سند را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
name String عنوان سند جدید

بازگشت

Document - سند فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

set Selection(range)

انتخاب کاربر را در برگه فعال با توجه به Range تنظیم می کند. یک اسکریپت فقط می‌تواند به انتخاب کاربری که اسکریپت را اجرا می‌کند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد. 

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

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

پارامترها

نام تایپ کنید توضیحات
range Range طیف جدیدی از عناصر برای انتخاب.

بازگشت

Document - این Document ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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