Class: Google::Apis::DocsV1::ParagraphElement

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/docs_v1/classes.rb,
lib/google/apis/docs_v1/representations.rb,
lib/google/apis/docs_v1/representations.rb

Overview

A ParagraphElement describes content within a Paragraph.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ParagraphElement

Returns a new instance of ParagraphElement.



3826
3827
3828
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3826

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auto_text ⇒ Google::Apis::DocsV1::AutoText

A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. Corresponds to the JSON property autoText

Returns:



3758
3759
3760
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3758

def auto_text
  @auto_text
end

#column_break ⇒ Google::Apis::DocsV1::ColumnBreak

A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. Corresponds to the JSON property columnBreak

Returns:



3764
3765
3766
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3764

def column_break
  @column_break
end

#date_element ⇒ Google::Apis::DocsV1::DateElement

A date instance mentioned in a document. Corresponds to the JSON property dateElement

Returns:



3769
3770
3771
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3769

def date_element
  @date_element
end

#end_index ⇒ Fixnum

The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


3775
3776
3777
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3775

def end_index
  @end_index
end

#equation ⇒ Google::Apis::DocsV1::Equation

A ParagraphElement representing an equation. Corresponds to the JSON property equation

Returns:



3780
3781
3782
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3780

def equation
  @equation
end

#footnote_reference ⇒ Google::Apis::DocsV1::FootnoteReference

A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. Corresponds to the JSON property footnoteReference

Returns:



3786
3787
3788
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3786

def footnote_reference
  @footnote_reference
end

#horizontal_rule ⇒ Google::Apis::DocsV1::HorizontalRule

A ParagraphElement representing a horizontal line. Corresponds to the JSON property horizontalRule

Returns:



3791
3792
3793
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3791

def horizontal_rule
  @horizontal_rule
end

#inline_object_element ⇒ Google::Apis::DocsV1::InlineObjectElement

A ParagraphElement that contains an InlineObject. Corresponds to the JSON property inlineObjectElement

Returns:



3796
3797
3798
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3796

def inline_object_element
  @inline_object_element
end

#page_break ⇒ Google::Apis::DocsV1::PageBreak

A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. Corresponds to the JSON property pageBreak

Returns:



3802
3803
3804
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3802

def page_break
  @page_break
end

#person ⇒ Google::Apis::DocsV1::Person

A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. Corresponds to the JSON property person

Returns:



3808
3809
3810
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3808

def person
  @person
end

#rich_link ⇒ Google::Apis::DocsV1::RichLink

A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). Corresponds to the JSON property richLink

Returns:



3814
3815
3816
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3814

def rich_link
  @rich_link
end

#start_index ⇒ Fixnum

The zero-based start index of this paragraph element, in UTF-16 code units. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


3819
3820
3821
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3819

def start_index
  @start_index
end

#text_run ⇒ Google::Apis::DocsV1::TextRun

A ParagraphElement that represents a run of text that all has the same styling. Corresponds to the JSON property textRun

Returns:



3824
3825
3826
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3824

def text_run
  @text_run
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3831

def update!(**args)
  @auto_text = args[:auto_text] if args.key?(:auto_text)
  @column_break = args[:column_break] if args.key?(:column_break)
  @date_element = args[:date_element] if args.key?(:date_element)
  @end_index = args[:end_index] if args.key?(:end_index)
  @equation = args[:equation] if args.key?(:equation)
  @footnote_reference = args[:footnote_reference] if args.key?(:footnote_reference)
  @horizontal_rule = args[:horizontal_rule] if args.key?(:horizontal_rule)
  @inline_object_element = args[:inline_object_element] if args.key?(:inline_object_element)
  @page_break = args[:page_break] if args.key?(:page_break)
  @person = args[:person] if args.key?(:person)
  @rich_link = args[:rich_link] if args.key?(:rich_link)
  @start_index = args[:start_index] if args.key?(:start_index)
  @text_run = args[:text_run] if args.key?(:text_run)
end