Belirli bir öğeye göre doküman sekmesindeki bir konuma başvuru. Kullanıcının imleci
değeri, diğer kullanımların yanı sıra Position
olarak temsil edilir. Komut dosyaları yalnızca
işlemini yapan kullanıcıdır. Kullanıcının yalnızca komut dosyası dokümana bağlı olması gerekir.
// 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.'); }
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
getElement() | Element | Bu Position öğesini içeren öğeyi alır. |
getOffset() | Integer | Bu Position öğesinin, onu içeren öğe içindeki göreli konumunu alır. |
getSurroundingText() | Text | Öğenin metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur:
Position öğesini içeren Paragraph veya ListItem (doğrudan veya bir alt öğe zinciri aracılığıyla). |
getSurroundingTextOffset() | Integer | getSurroundingText() tarafından döndürülen Text öğesi içinde bu Position öğesinin ofsetini alır. |
insertBookmark() | Bookmark | Bu Position için yeni bir Bookmark oluşturup ekler. |
insertInlineImage(image) | InlineImage | Belirtilen resimden bu Position üzerinde yeni bir InlineImage oluşturur ve ekler
dağınıklığı oluşturur. |
insertText(text) | Text | Belirtilen metni Position konumuna ekler. |
Ayrıntılı belgeler
getElement()
Bu Position
öğesini içeren öğeyi alır. Bu, bir Text
öğesi veya Paragraph
gibi bir kapsayıcı öğe. Her iki durumda da,
öğe içindeki konum getOffset()
ile belirlenebilir.
Return
Element
: Bu Position
nesnesinin bulunduğu kapsayıcı veya Text
öğesi
getOffset()
Bu Position
öğesinin, onu içeren öğe içindeki göreli konumunu alır. Öğe
öğesi bir Text
öğesidir; uzaklık, Position
öğesinden önceki karakter sayısıdır (yani bu Position
öğesinden sonraki karakterin dizinidir). diğer
öğesi için, ofset değeri bu Position
öğesinden önceki alt öğelerin sayısıdır.
aynı kapsayıcı öğe (yani, Position
öğesinden sonraki alt öğenin dizini).
Return
Integer
— Text
öğeleri için bu Position
öğesinden önceki karakter sayısı; şunun için:
diğer öğelerin sayısı, aynı içindeki bu Position
öğesinden önceki alt öğelerin sayısı
kapsayıcı öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingText()
Öğenin metnini ve biçimlendirmesini temsil eden yapay bir Text
öğesi oluşturur:
Position
öğesini içeren Paragraph
veya ListItem
(doğrudan veya bir alt öğe zinciri aracılığıyla). Döndürülen Text
öğesinde Position
ofsetini belirlemek için getSurroundingTextOffset()
işlevini kullanın.
Return
Text
- editAsText()
çağrısının sonucuna eşdeğer bir öğe
Position
öğesini içeren Paragraph
ya da ListItem
için doğrudan veya bir alt öğe zinciri aracılığıyla
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingTextOffset()
getSurroundingText()
tarafından döndürülen Text
öğesi içinde bu Position
öğesinin ofsetini alır. Göreli konum, Position
karakterinden önceki karakter sayısıdır.
(yani, bu Position
öğesinden sonraki karakterin dizini).
Return
Integer
: Doğrudan veya bir alt öğeler zinciri aracılığıyla, Position
öğesini içeren Paragraph
veya ListItem
içinde bu Position
öğesinden önce gelen karakter sayısı
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertBookmark()
Bu Position
için yeni bir Bookmark
oluşturup ekler.
Return
Bookmark
— yeni yer işareti
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(image)
Belirtilen resimden bu Position
üzerinde yeni bir InlineImage
oluşturur ve ekler
dağınıklığı oluşturur.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
image | BlobSource | bu Position konumuna eklenecek resim verileri |
Return
InlineImage
— yeni resim öğesi veya bu Position
öğesinin içinde bulunduğu öğe ise null
resmin eklenmesine izin vermiyor
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(text)
Belirtilen metni Position
konumuna ekler. Bu yöntemle yeni bir Text
oluşturulur
öğesi, dize mevcut bir Text
öğesinin içine eklenmiş olsa bile
stilini belirlemek çok kolay.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Position konumuna eklenecek dize |
Return
Text
— yeni metin öğesi veya bu Position
öğesinin içinde bulunduğu öğeyse null
konumu metin eklenmesine izin vermiyor
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents