Class: Google::Apis::DocsV1::SectionStyle

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

The styling that applies to a section.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SectionStyle

Returns a new instance of SectionStyle.



4899
4900
4901
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4899

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

Instance Attribute Details

#column_properties ⇒ Array<Google::Apis::DocsV1::SectionColumnProperties>

The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. Corresponds to the JSON property columnProperties

Returns:



4762
4763
4764
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4762

def column_properties
  @column_properties
end

#column_separator_style ⇒ String

The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property columnSeparatorStyle

Returns:

  • (String) 


4769
4770
4771
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4769

def column_separator_style
  @column_separator_style
end

#content_direction ⇒ String

The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property contentDirection

Returns:

  • (String) 


4776
4777
4778
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4776

def content_direction
  @content_direction
end

#default_footer_id ⇒ String

The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. Corresponds to the JSON property defaultFooterId

Returns:

  • (String) 


4783
4784
4785
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4783

def default_footer_id
  @default_footer_id
end

#default_header_id ⇒ String

The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. Corresponds to the JSON property defaultHeaderId

Returns:

  • (String) 


4790
4791
4792
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4790

def default_header_id
  @default_header_id
end

#even_page_footer_id ⇒ String

The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak' s SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. Corresponds to the JSON property evenPageFooterId

Returns:

  • (String) 


4800
4801
4802
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4800

def even_page_footer_id
  @even_page_footer_id
end

#even_page_header_id ⇒ String

The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak' s SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. Corresponds to the JSON property evenPageHeaderId

Returns:

  • (String) 


4810
4811
4812
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4810

def even_page_header_id
  @even_page_header_id
end

#first_page_footer_id ⇒ String

The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. Corresponds to the JSON property firstPageFooterId

Returns:

  • (String) 


4821
4822
4823
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4821

def first_page_footer_id
  @first_page_footer_id
end

#first_page_header_id ⇒ String

The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. Corresponds to the JSON property firstPageHeaderId

Returns:

  • (String) 


4832
4833
4834
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4832

def first_page_header_id
  @first_page_header_id
end

#flip_page_orientation ⇒ Boolean Also known as: flip_page_orientation?

Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property flipPageOrientation

Returns:

  • (Boolean) 


4841
4842
4843
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4841

def flip_page_orientation
  @flip_page_orientation
end

#margin_bottom ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginBottom

Returns:



4847
4848
4849
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4847

def margin_bottom
  @margin_bottom
end

#margin_footer ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginFooter

Returns:



4852
4853
4854
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4852

def margin_footer
  @margin_footer
end

#margin_header ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginHeader

Returns:



4857
4858
4859
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4857

def margin_header
  @margin_header
end

#margin_left ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginLeft

Returns:



4862
4863
4864
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4862

def margin_left
  @margin_left
end

#margin_right ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginRight

Returns:



4867
4868
4869
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4867

def margin_right
  @margin_right
end

#margin_top ⇒ Google::Apis::DocsV1::Dimension

A magnitude in a single direction in the specified units. Corresponds to the JSON property marginTop

Returns:



4872
4873
4874
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4872

def margin_top
  @margin_top
end

#page_number_start ⇒ Fixnum

The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property pageNumberStart

Returns:

  • (Fixnum) 


4881
4882
4883
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4881

def page_number_start
  @page_number_start
end

#section_type ⇒ String

Output only. The type of section. Corresponds to the JSON property sectionType

Returns:

  • (String) 


4886
4887
4888
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4886

def section_type
  @section_type
end

#use_first_page_header_footer ⇒ Boolean Also known as: use_first_page_header_footer?

Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. Corresponds to the JSON property useFirstPageHeaderFooter

Returns:

  • (Boolean) 


4896
4897
4898
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4896

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4904

def update!(**args)
  @column_properties = args[:column_properties] if args.key?(:column_properties)
  @column_separator_style = args[:column_separator_style] if args.key?(:column_separator_style)
  @content_direction = args[:content_direction] if args.key?(:content_direction)
  @default_footer_id = args[:default_footer_id] if args.key?(:default_footer_id)
  @default_header_id = args[:default_header_id] if args.key?(:default_header_id)
  @even_page_footer_id = args[:even_page_footer_id] if args.key?(:even_page_footer_id)
  @even_page_header_id = args[:even_page_header_id] if args.key?(:even_page_header_id)
  @first_page_footer_id = args[:first_page_footer_id] if args.key?(:first_page_footer_id)
  @first_page_header_id = args[:first_page_header_id] if args.key?(:first_page_header_id)
  @flip_page_orientation = args[:flip_page_orientation] if args.key?(:flip_page_orientation)
  @margin_bottom = args[:margin_bottom] if args.key?(:margin_bottom)
  @margin_footer = args[:margin_footer] if args.key?(:margin_footer)
  @margin_header = args[:margin_header] if args.key?(:margin_header)
  @margin_left = args[:margin_left] if args.key?(:margin_left)
  @margin_right = args[:margin_right] if args.key?(:margin_right)
  @margin_top = args[:margin_top] if args.key?(:margin_top)
  @page_number_start = args[:page_number_start] if args.key?(:page_number_start)
  @section_type = args[:section_type] if args.key?(:section_type)
  @use_first_page_header_footer = args[:use_first_page_header_footer] if args.key?(:use_first_page_header_footer)
end