Belge sekmesindeki belirli bir öğeye göre bir konuma referans. Kullanıcının imleci, diğer kullanımların yanı sıra Position
olarak gösterilir. Komut dosyaları yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve bu da yalnızca komut dosyası dokümana bağlıysa geçerlidir.
// 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.'); }
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
get | Element | Bu Position öğesini içeren öğeyi alır. |
get | Integer | Bu Position 'nin, onu içeren öğe içindeki göreli konumunu alır. |
get | Text | Doğrudan veya bir alt öğe zinciri aracılığıyla Position içeren Paragraph ya da List öğesinin metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur. |
get | Integer | get tarafından döndürülen Text öğesi içindeki bu Position öğesinin ofsetini alır. |
insert | Bookmark | Bu Position noktasında yeni bir Bookmark oluşturup ekler. |
insert | Inline | Belirtilen resim blob'undan bu Position noktasına yeni bir Inline oluşturup ekler. |
insert | Text | Belirtilen metni bu Position alanına ekler. |
Ayrıntılı dokümanlar
get Element()
Bu Position
öğesini içeren öğeyi alır. Bu, bir Text
öğesi veya Paragraph
gibi bir kapsayıcı öğesidir. Her iki durumda da öğe içindeki göreli konum get
ile belirlenebilir.
Return
Element
: Bu Position
nesnesinin bulunduğu kapsayıcı veya Text
öğesi
get Offset()
Bu Position
'nin, onu içeren öğe içindeki göreli konumunu alır. Öğe bir Text
öğesiyse ofset, Position
işaretinden önceki karakter sayısıdır (yani bu Position
işaretinden sonraki karakterin dizini); diğer öğeler için ofset, aynı kapsayıcı öğe içinde bu Position
işaretinden önceki alt öğe sayısıdır (yani Position
işaretinden sonraki alt öğenin dizini).
Return
Integer
: Text
öğeleri için bu Position
öğesinden önceki karakter sayısı, diğer öğeler için aynı kapsayıcı öğe içinde bu Position
öğesinden önceki alt öğe sayısı
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Surrounding Text()
Doğrudan veya bir alt öğe zinciri aracılığıyla Position
içeren Paragraph
ya da List
öğesinin metnini ve biçimlendirmesini temsil eden yapay bir Text
öğesi oluşturur. Döndürülen Text
öğesinde Position
öğesinin ofsetini belirlemek için get
öğesini kullanın.
Return
Text
: Position
öğesini doğrudan veya bir alt öğe zinciri aracılığıyla içeren Paragraph
veya List
üzerinde edit
çağrılmasının sonucuna eşdeğer bir öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Surrounding Text Offset()
get
tarafından döndürülen Text
öğesi içindeki bu Position
öğesinin ofsetini alır. Ofset, Position
karakterinden önceki karakter sayısıdır (yani bu Position
karakterinden sonraki karakterin dizini).
Return
Integer
: Position
'yi içeren Paragraph
veya List
öğesinde, doğrudan veya alt öğe zinciri aracılığıyla bu Position
'den önceki karakter sayısı
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Bookmark()
Bu Position
noktasında yeni bir Bookmark
oluşturup ekler.
Return
Bookmark
: Yeni yer işareti
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(image)
Belirtilen resim blob'undan bu Position
noktasına yeni bir Inline
oluşturup ekler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
image | Blob | Bu Position alanına eklenecek resim verileri |
Return
Inline
: Yeni resim öğesi veya bu Position
öğesinin bulunduğu öğe resim eklenmesine izin vermiyorsa null
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(text)
Belirtilen metni bu Position
alanına ekler. Bu yöntem, dize mevcut bir Text
öğesine yerleştirilmiş olsa bile yeni bir Text
öğesi oluşturur. Böylece yeni öğenin stilini kolayca ayarlayabilirsiniz.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Bu Position alanına eklenecek dize |
Return
Text
: Yeni metin öğesi veya bu Position
öğesinin bulunduğu öğe metin eklenmesine izin vermiyorsa null
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents