Class DocumentApp

DocumentApp

سرویس اسناد Documents قابل ویرایش را ایجاد و باز می کند.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
var doc = DocumentApp.openById('DOCUMENT_ID');

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

خواص

اموال تایپ کنید توضیحات
Attribute Attribute شمارش Attribute
ElementType ElementType شمارش ElementType
FontFamily FontFamily شمارش FontFamily .
GlyphType GlyphType شمارش GlyphType .
HorizontalAlignment HorizontalAlignment شمارش HorizontalAlignment .
ParagraphHeading ParagraphHeading شمارش سرفصل ParagraphHeading .
PositionedLayout PositionedLayout شمارش PositionedLayout .
TextAlignment TextAlignment شمارش TextAlignment .
VerticalAlignment VerticalAlignment شمارش VerticalAlignment .

روش ها

روش نوع برگشت شرح مختصر
create(name) Document یک سند جدید ایجاد و برمی گرداند.
getActiveDocument() Document سندی را که اسکریپت به آن محدود شده است برمی‌گرداند.
getUi() Ui نمونه‌ای از محیط رابط کاربری سند را برمی‌گرداند که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، گفتگوها و نوارهای جانبی را اضافه کند.
openById(id) Document سند را با شناسه مشخص شده برمی گرداند.
openByUrl(url) Document سند را با URL مشخص شده باز می کند و برمی گرداند.

مستندات دقیق

create(name)

یک سند جدید ایجاد و برمی گرداند.

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

پارامترها

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

بازگشت

Document - نمونه سند جدید.

مجوز

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

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

getActiveDocument()

سندی را که اسکریپت به آن محدود شده است برمی‌گرداند. برای تعامل با سندی که اسکریپت به آن محدود نشده است، به جای آن از openById(id) یا openByUrl(url) استفاده کنید.

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

بازگشت

Document - نمونه سند

مجوز

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

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

getUi()

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

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

بازگشت

Ui - نمونه ای از محیط رابط کاربری این سند

openById(id)

سند را با شناسه مشخص شده برمی گرداند. اگر اسکریپت به سند متصل است، به جای آن از getActiveDocument() استفاده کنید.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
var doc = DocumentApp.openById('DOCUMENT_ID');

پارامترها

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

بازگشت

Document - نمونه سند.

مجوز

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

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

openByUrl(url)

سند را با URL مشخص شده باز می کند و برمی گرداند. اگر اسکریپت به سند متصل است، به جای آن از getActiveDocument() استفاده کنید.

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

پارامترها

نام تایپ کنید توضیحات
url String نشانی اینترنتی سند برای باز کردن

بازگشت

Document - نمونه سند

مجوز

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

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