یک سند، حاوی متن غنی و عناصری مانند جداول و فهرست ها.
ممکن است اسناد با استفاده از DocumentApp
باز یا ایجاد شوند.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
مواد و روش ها
روش | نوع برگشت | توضیح مختصر |
---|---|---|
addBookmark(position) | Bookmark | یک Bookmark در Position داده شده اضافه می کند. |
addEditor(emailAddress) | Document | کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. |
addEditor(user) | Document | کاربر داده شده را به لیست ویرایشگرهای Document اضافه می کند. |
addEditors(emailAddresses) | Document | آرایه داده شده از کاربران را به لیست ویرایشگرهای Document اضافه می کند. |
addFooter() | FooterSection | بخش پاورقی سند را اضافه می کند، اگر وجود نداشته باشد. |
addHeader() | HeaderSection | یک بخش سرصفحه سند را اضافه می کند، اگر وجود نداشته باشد. |
addNamedRange(name, range) | NamedRange | NamedRange را اضافه میکند، که Range است که دارای نام و شناسه برای بازیابی بعدی است. |
addViewer(emailAddress) | Document | کاربر داده شده را به لیست بینندگان Document اضافه می کند. |
addViewer(user) | Document | کاربر داده شده را به لیست بینندگان Document اضافه می کند. |
addViewers(emailAddresses) | Document | آرایه داده شده از کاربران را به لیست بینندگان Document اضافه می کند. |
getAs(contentType) | Blob | محتویات Document فعلی را به عنوان یک حباب از نوع مشخص شده بازیابی می کند. |
getBlob() | Blob | محتویات Document فعلی را به صورت لکه ای بازیابی می کند. |
getBody() | Body | Body سند فعال را بازیابی می کند. |
getBookmark(id) | Bookmark | Bookmark با شناسه داده شده دریافت می کند. |
getBookmarks() | Bookmark[] | همه اشیاء Bookmark را در سند دریافت می کند. |
getCursor() | Position | نشانگر کاربر را در سند فعال دریافت می کند. |
getEditors() | User[] | لیست ویرایشگران این Document را دریافت می کند. |
getFooter() | FooterSection | بخش پاورقی سند را در صورت وجود بازیابی می کند. |
getFootnotes() | Footnote[] | تمام عناصر Footnote را در بدنه سند بازیابی می کند. |
getHeader() | HeaderSection | بخش سرصفحه سند را در صورت وجود بازیابی می کند. |
getId() | String | شناسه منحصر به فرد سند را بازیابی می کند. |
getLanguage() | String | کد زبان سند را دریافت می کند. |
getName() | String | عنوان سند را بازیابی می کند. |
getNamedRangeById(id) | NamedRange | NamedRange با شناسه داده شده دریافت می کند. |
getNamedRanges() | NamedRange[] | تمام اشیاء NamedRange را در سند دریافت می کند. |
getNamedRanges(name) | NamedRange[] | تمام اشیاء NamedRange را در سند با نام داده شده دریافت می کند. |
getSelection() | Range | انتخاب کاربر را در سند فعال دریافت می کند. |
getSupportedLanguageCodes() | String[] | همه کدهای زبانی که در فایلهای Google Docs پشتیبانی میشوند را دریافت میکند. |
getUrl() | String | URL را برای دسترسی به سند فعلی بازیابی می کند. |
getViewers() | User[] | لیست بینندگان و نظر دهندگان را برای این Document دریافت می کند. |
newPosition(element, offset) | Position | یک Position جدید ایجاد می کند، که اشاره ای به مکانی در سند، نسبت به یک عنصر خاص است. |
newRange() | RangeBuilder | سازنده ای ایجاد می کند که برای ساخت اشیاء Range از عناصر سند استفاده می شود. |
removeEditor(emailAddress) | Document | کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. |
removeEditor(user) | Document | کاربر داده شده را از لیست ویرایشگرهای Document حذف می کند. |
removeViewer(emailAddress) | Document | کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. |
removeViewer(user) | Document | کاربر داده شده را از لیست بینندگان و نظردهندگان Document حذف می کند. |
saveAndClose() | void | Document فعلی را ذخیره می کند. |
setCursor(position) | Document | مکان نما کاربر را در سند فعال، با توجه به یک Position تنظیم می کند. |
setLanguage(languageCode) | Document | کد زبان سند را تنظیم می کند. |
setName(name) | Document | عنوان سند را تنظیم می کند. |
setSelection(range) | Document | انتخاب کاربر را در سند فعال با یک Range تنظیم می کند. |
مستندات دقیق
addBookmark(position)
یک Bookmark
در 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('abc123456'); // Gets the document 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
addEditor(emailAddress)
کاربر داده شده را به لیست ویرایشگرهای Document
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
کاربر داده شده را به لیست ویرایشگرهای Document
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
user | User | نمایشی از کاربر برای افزودن. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
آرایه داده شده از کاربران را به لیست ویرایشگرهای Document
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای افزودن. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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('abc123456'); // Adds a header to the document. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
برگشت
HeaderSection
- سرصفحه سند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
NamedRange
را اضافه میکند، که Range
است که دارای نام و شناسه برای بازیابی بعدی است. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک سند می توانند یک نام مشترک داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسهها در سند منحصر به فرد هستند، مانند شناسه در HTML. پس از افزودن NamedRange
به یک سند، نمیتوانید آن را تغییر دهید، فقط میتوانید آن را حذف کنید.
هر اسکریپتی که به سند دسترسی داشته باشد می تواند به NamedRange
دسترسی داشته باشد. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.
// Creates a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.addNamedRange('Document tables', rangeBuilder.build());
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام محدوده، که لازم نیست منحصر به فرد باشد. نام محدوده باید بین 1 تا 256 کاراکتر باشد. |
range | Range | محدوده عناصری که باید با نام مرتبط شوند. محدوده می تواند انتخاب فعال ، یک نتیجه جستجو ، یا به صورت دستی با newRange() ساخته شود. |
برگشت
NamedRange
- NamedRange
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
کاربر داده شده را به لیست بینندگان Document
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
کاربر داده شده را به لیست بینندگان Document
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
user | User | نمایشی از کاربر برای افزودن. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
آرایه داده شده از کاربران را به لیست بینندگان Document
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای افزودن. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(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('abc123456'); // 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());
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
contentType | String | نوع MIME برای تبدیل؛ در حال حاضر فقط 'application/pdf' پشتیبانی می شود. |
برگشت
Blob
- سند فعلی به عنوان یک لکه.
getBlob()
محتویات 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('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
برگشت
Blob
- سند فعلی به عنوان یک لکه.
getBody()
Body
سند فعال را بازیابی می کند.
اسناد ممکن است شامل انواع مختلفی از بخش ها باشند (به عنوان مثال HeaderSection
، FooterSection
). بخش فعال یک سند 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('abc123456'); // Gets the document 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
getBookmark(id)
Bookmark
با شناسه داده شده دریافت می کند. اگر چنین 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('abc123456'); // Gets the bookmark by its ID. 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
getBookmarks()
همه اشیاء Bookmark
را در سند دریافت می کند.
// 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('abc123456'); // Gets all of the bookmarks in the document. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the document to the console. console.log(bookmarks.length);
برگشت
Bookmark[]
- آرایه ای از اشیاء Bookmark
در سند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
نشانگر کاربر را در سند فعال دریافت می کند. یک اسکریپت فقط میتواند به مکاننمای کاربری که اسکریپت را اجرا میکند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.
// Insert some text at the cursor position and make it bold. var 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. var 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
getEditors()
getFootnotes()
تمام عناصر Footnote
را در بدنه سند بازیابی می کند.
فراخوانی به getFootnotes
باعث تکرار در عناصر سند می شود. برای اسناد بزرگ، از تماس های غیر ضروری با این روش خودداری کنید.
// 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('abc123456'); // Gets the first footnote. 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
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('abc123456'); // Gets the text of the document's header and logs it to the console. console.log(doc.getHeader().getText());
برگشت
HeaderSection
- سرصفحه سند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
شناسه منحصر به فرد سند را بازیابی می کند. شناسه سند با DocumentApp.openById()
برای باز کردن یک نمونه سند خاص استفاده می شود.
برگشت
String
- شناسه سند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
کد زبان سند را دریافت می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد.
برگشت
String
- زبان سند، یا اگر تعریف نشده باشد، null
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
عنوان سند را بازیابی می کند.
برگشت
String
- عنوان سند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
NamedRange
با شناسه داده شده دریافت می کند. اگر چنین NamedRange
وجود نداشته باشد، این متد null
را برمیگرداند. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک سند ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسهها در سند منحصر به فرد هستند، مانند شناسه در HTML.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
id | String | شناسه محدوده، که در سند منحصر به فرد است |
برگشت
NamedRange
- NamedRange
با شناسه داده شده، یا اگر چنین محدوده ای وجود نداشته باشد، null
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
تمام اشیاء NamedRange
را در سند دریافت می کند.
یک NamedRange
با هر اسکریپتی که به سند دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.
برگشت
NamedRange[]
- آرایه ای از اشیاء NamedRange
در سند، احتمالاً شامل چندین محدوده با همان نام
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
تمام اشیاء NamedRange
را در سند با نام داده شده دریافت می کند. نام ها لزوما منحصر به فرد نیستند. چندین محدوده مختلف در یک سند ممکن است نام یکسانی داشته باشند، بسیار شبیه یک کلاس در HTML. در مقابل، شناسهها در سند منحصر به فرد هستند، مانند شناسه در HTML.
یک NamedRange
با هر اسکریپتی که به سند دسترسی دارد قابل دسترسی است. برای جلوگیری از درگیری های ناخواسته بین اسکریپت ها، پیشوند نام محدوده را با یک رشته منحصر به فرد در نظر بگیرید.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | نام محدوده، که لزوما منحصر به فرد نیست |
برگشت
NamedRange[]
- آرایه ای از اشیاء NamedRange
در سند با نام داده شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
انتخاب کاربر را در سند فعال دریافت می کند. یک اسکریپت فقط میتواند به انتخاب کاربری که اسکریپت را اجرا میکند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var 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
getSupportedLanguageCodes()
همه کدهای زبانی که در فایلهای Google Docs پشتیبانی میشوند را دریافت میکند.
برگشت
String[]
- آرایه ای از کدهای زبان.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
URL را برای دسترسی به سند فعلی بازیابی می کند.
var 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
getViewers()
لیست بینندگان و نظر دهندگان را برای این Document
دریافت می کند.
برگشت
User[]
- آرایه ای از کاربران با مجوز مشاهده یا نظر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
یک Position
جدید ایجاد می کند، که اشاره ای به مکانی در سند، نسبت به یک عنصر خاص است. مکاننمای کاربر در میان سایر کاربردها بهعنوان یک Position
نمایش داده میشود.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var 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
newRange()
سازنده ای ایجاد می کند که برای ساخت اشیاء Range
از عناصر سند استفاده می شود.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
برگشت
RangeBuilder
- سازنده جدید
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
کاربر داده شده را از لیست ویرایشگرهای Document
حذف می کند. اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document
را مسدود نمیکند - برای مثال، اگر Document
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست بینندگان حذف میکند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای حذف. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
کاربر داده شده را از لیست ویرایشگرهای Document
حذف می کند. اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، این روش، دسترسی به Document
را مسدود نمیکند - برای مثال، اگر Document
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست بینندگان حذف میکند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
user | User | نمایشی از کاربر برای حذف. |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
کاربر داده شده را از لیست بینندگان و نظردهندگان Document
حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده یا نظر دهنده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document
را مسدود نمیکند - به عنوان مثال، اگر Document
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف میکند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای حذف. |
برگشت
Document
- این Document
برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
کاربر داده شده را از لیست بینندگان و نظردهندگان Document
حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Document
را مسدود نمیکند - به عنوان مثال، اگر Document
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Document
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف میکند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
user | User | نمایشی از کاربر برای حذف. |
برگشت
Document
- این Document
برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
Document
فعلی را ذخیره می کند. باعث می شود که به روز رسانی های معلق پاک و اعمال شوند.
متد saveAndClose()
به طور خودکار در پایان اجرای اسکریپت برای هر Document
قابل ویرایش باز فراخوانی می شود.
یک Document
بسته قابل ویرایش نیست. از DocumentApp.openById()
برای باز کردن مجدد یک سند معین برای ویرایش استفاده کنید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
مکان نما کاربر را در سند فعال، با توجه به یک Position
تنظیم می کند. یک اسکریپت فقط میتواند به مکاننمای کاربری که اسکریپت را اجرا میکند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.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
setLanguage(languageCode)
کد زبان سند را تنظیم می کند. این زبانی است که در فایل ویرایشگر سند نشان داده شده است > زبان ، که ممکن است زبان واقعی سند نباشد. از getSupportedLanguageCodes()
برای دریافت همه کدهای زبان معتبر استفاده کنید.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
languageCode | String | کد زبان |
برگشت
Document
- این Document
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
عنوان سند را تنظیم می کند.
مولفه های
نام | تایپ کنید | شرح |
---|---|---|
name | String | عنوان سند جدید |
برگشت
Document
- سند فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
انتخاب کاربر را در سند فعال با یک Range
تنظیم می کند. یک اسکریپت فقط میتواند به انتخاب کاربری که اسکریپت را اجرا میکند، دسترسی داشته باشد، و تنها در صورتی که اسکریپت به سند متصل باشد.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var 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