Class Range

Range

A range of elements in a document. The user's selection is represented as a Range , among other uses. Scripts can only access the selection of the user who is running the script, and only if the script is bound to the document.

 // 
  
 Bold 
  
 all 
  
 selected 
  
 text 
 . 
 var 
  
 selection 
  
 = 
  
 DocumentApp 
 . 
 getActiveDocument 
 (). 
 getSelection 
 (); 
 if 
  
 ( 
 selection 
 ) 
  
 { 
  
 var 
  
 elements 
  
 = 
  
 selection 
 . 
 getRangeElements 
 (); 
  
 for 
  
 ( 
 var 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 elements 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 var 
  
 element 
  
 = 
  
 elements 
 [ 
 i 
 ] 
 ; 
  
 // 
  
 Only 
  
 modify 
  
 elements 
  
 that 
  
 can 
  
 be 
  
 edited 
  
 as 
  
 text 
 ; 
  
 skip 
  
 images 
  
 and 
  
 other 
  
 non 
 - 
 text 
  
 elements 
 . 
  
 if 
  
 ( 
 element 
 . 
 getElement 
 (). 
 editAsText 
 ) 
  
 { 
  
 var 
  
 text 
  
 = 
  
 element 
 . 
 getElement 
 (). 
 editAsText 
 (); 
  
 // 
  
 Bold 
  
 the 
  
 selected 
  
 part 
  
 of 
  
 the 
  
 element 
 , 
  
 or 
  
 the 
  
 full 
  
 element 
  
 if 
  
 it 
 ' 
 s 
  
 completely 
  
 selected 
 . 
  
 if 
  
 ( 
 element 
 . 
 isPartial 
 ()) 
  
 { 
  
 text 
 . 
 setBold 
 ( 
 element 
 . 
 getStartOffset 
 (), 
  
 element 
 . 
 getEndOffsetInclusive 
 (), 
  
 true 
 ); 
  
 } 
  
 else 
  
 { 
  
 text 
 . 
 setBold 
 ( 
 true 
 ); 
  
 } 
  
 } 
  
 } 
 }

Methods

Method Return type Brief description
getRangeElements()
RangeElement[] Gets all elements in this Range , including any partial Text elements (for example, in the case of a selection that includes only part of a Text element).

Detailed documentation

getRangeElements()

Gets all elements in this Range , including any partial Text elements (for example, in the case of a selection that includes only part of a Text element). To determine whether a Text element is only partially included in the range, see RangeElement.isPartial() .

Return

RangeElement[] — an array of elements, in the order they appear in the document

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

Deprecated methods