Class Document

یک 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());

پارامترها

بازگشت

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

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

اگر بخشی به عنوان پاورقی وجود نداشته باشد، آن را به اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، به تب فعال اضافه می‌کند. برای افزودن بخش پاورقی به هر تبی، از متد 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

اگر بخشی به عنوان سربرگ وجود نداشته باشد، آن را به اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، به تب فعال اضافه می‌کند. برای افزودن یک بخش سربرگ به هر تبی، از متد 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

یک 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());

پارامترها

بازگشت

Named Range — Named Range .

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

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

// 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());

پارامترها

بازگشت

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

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

// 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 — سند فعلی به عنوان یک blob.

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

Bookmark با شناسه (ID) داده شده در اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، در تب فعال دریافت می‌کند. برای دریافت یک نشانک در هر تب، از متد 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.');
}

پارامترها

بازگشت

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

مجوز

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

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

تمام اشیاء 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

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

// 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 — نمایش مکان‌نمای کاربر، یا اگر کاربر مکان‌نمایی در تب نداشته باشد یا اگر اسکریپت به سند محدود نشده باشد، null .

مجوز

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

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

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

بازگشت

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

مجوز

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

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

بخش پاورقی اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، بخش پاورقی تب فعال را بازیابی می‌کند. برای دریافت بخش پاورقی هر تب، از متد 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 |null — پاورقی برگه.

مجوز

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

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

تمام عناصر 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[] |null — پاورقی‌های تب.

مجوز

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

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

بخش سربرگ اولین تب یا برای اسکریپت‌هایی که به یک سند متصل هستند، بخش سربرگ تب فعال را بازیابی می‌کند. برای دریافت بخش سربرگ هر تب، از متد 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 |null — سربرگ برگه.

مجوز

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

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

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

بازگشت

String - شناسه سند.

مجوز

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

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

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

بازگشت

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

مجوز

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

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

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

بازگشت

String - عنوان سند.

مجوز

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

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

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

پارامترها

بازگشت

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

مجوز

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

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

تمام اشیاء 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

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

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

پارامترها

بازگشت

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

مجوز

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

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

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

// 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 — نمایشی از انتخاب کاربر، یا null اگر کاربر چیزی در برگه انتخاب نکرده باشد، اگر فقط انتهای یک پاراگراف انتخاب شده باشد، اگر فقط انتهای یک پاراگراف و یک خط جدید انتخاب شده باشند، یا اگر اسکریپت به سند محدود نشده باشد.

مجوز

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

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

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

بازگشت

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

مجوز

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

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

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

پارامترها

بازگشت

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

مجوز

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

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

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

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

بازگشت

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

مجوز

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

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

آدرس اینترنتی (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

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

بازگشت

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

مجوز

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

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

یک 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);

پارامترها

بازگشت

Position — Position جدید.

مجوز

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

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

یک سازنده ایجاد می‌کند که برای ساخت اشیاء Range از عناصر tab در اولین tab یا برای اسکریپت‌هایی که به یک سند متصل هستند، از تب فعال استفاده می‌شود. برای ایجاد یک سازنده که برای ساخت اشیاء Document Range از عناصر tab در هر tab استفاده می‌شود، از متد 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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

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

پارامترها

بازگشت

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

مجوز

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

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

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

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

پارامترها

بازگشت

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

مجوز

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

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

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

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

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

مجوز

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

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

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');

پارامترها

مجوز

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

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

مکان‌نمای کاربر را با توجه به 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);

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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

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

پارامترها

بازگشت

Document — سند فعلی.

مجوز

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

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

انتخاب کاربر در تب فعال را با توجه به یک 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());

پارامترها

بازگشت

Document — این Document ، برای زنجیره‌سازی.

مجوز

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

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