Bu sayfa, Cloud Translation API ile çevrilmiştir.

Class Position

Dokümandaki bir konumun belirli bir öğeye göre başvurusu. Kullanıcının imleci, diğer kullanımların yanı sıra Position olarak temsil edilir. Komut dosyaları, yalnızca komut dosyasını çalıştıran kullanıcının imlecine erişebilir ve komut dosyasının 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, kendisini içeren öğe içindeki göreli konumunu alır.
`getSurroundingText()`	`Text`	Doğrudan veya bir alt öğe zinciri aracılığıyla, `Position` öğesini içeren `Paragraph` veya `ListItem` metnini ve biçimlendirmesini temsil eden yapay bir `Text` öğesi oluşturur.
`getSurroundingTextOffset()`	`Integer`	`getSurroundingText()` tarafından döndürülen `Text` öğesi içinde bu `Position` öğesinin ofsetini alır.
`insertBookmark()`	`Bookmark`	Bu `Position` içinde yeni bir `Bookmark` oluşturur ve ekler.
`insertInlineImage(image)`	`InlineImage`	Bu `Position` öğesi için belirtilen resim blobundan yeni bir `InlineImage` oluşturur ve ekler.
`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 olacaktır. Her iki durumda da, öğe içindeki göreli konum getOffset() ile belirlenebilir.

Return

Element — bu Position nesnesinin bulunduğu kapsayıcı veya Text öğesi

`getOffset()`

Bu Position öğesinin, kendisini içeren öğe içindeki göreli konumunu alır. Öğe bir Text öğesiyse uzaklık, Position karakterinden önceki karakter sayısıdır (yani bu Position karakterinden sonraki karakter dizini); diğer herhangi bir öğe için ofset, aynı kapsayıcı öğe içinde Position öğesinden önceki alt öğelerin 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ı öğesinde bu Position öğesinden önceki alt öğelerin sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

`getSurroundingText()`

Doğrudan veya bir alt öğe zinciri aracılığıyla, Position öğesini içeren Paragraph veya ListItem metnini ve biçimlendirmesini temsil eden yapay bir Text öğesi oluşturur. Döndürülen Text öğesinde Position ofsetini belirlemek için getSurroundingTextOffset() değerini kullanın.

Return

Text: Position öğesini içeren Paragraph veya ListItem üzerinde editAsText() çağrısının sonucuna eşdeğer bir öğe (doğrudan veya bir alt öğe zinciri aracılığıyla)

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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. Ofset, Position öğesinden önceki karakter sayısıdır (yani bu Position karakterinden sonraki karakter dizini).

Return

Integer: Doğrudan veya bir alt öğe zinciri aracılığıyla Position öğesini içeren Paragraph veya ListItem içinde bu Position'dan önceki karakter sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

`insertBookmark()`

Bu Position içinde yeni bir Bookmark oluşturur ve ekler.

Return

Bookmark — yeni yer işareti

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

`insertInlineImage(image)`

Bu Position öğesi için belirtilen resim blobundan yeni bir InlineImage oluşturur ve ekler.

Parametreler

Ad	Tür	Açıklama
`image`	`BlobSource`	bu `Position` konumuna eklenecek resim verileri

Return

InlineImage — yeni resim öğesi veya bu Position öğesinin bulunduğu öğe, resimlerin eklenmesine izin vermiyorsa null

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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öntem, dize mevcut bir Text öğesinin içine eklenmiş olsa bile yeni bir Text öğesi oluşturur. Böylece yeni öğenin stilini belirlemek kolaylaşır.

Parametreler

Ad	Tür	Açıklama
`text`	`String`	bu `Position` konumuna 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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