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.



4561
4562
4563
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4561

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 three 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:



4434
4435
4436
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4434

def column_properties
  @column_properties
end

#column_separator_style ⇒ String

The style of column separators. This style can be set even when there is 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) 


4441
4442
4443
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4441

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) 


4448
4449
4450
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4448

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) 


4455
4456
4457
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4455

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) 


4462
4463
4464
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4462

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 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 even_page_footer_id. This property is read-only. Corresponds to the JSON property evenPageFooterId

Returns:

  • (String) 


4472
4473
4474
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4472

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 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 even_page_header_id. This property is read-only. Corresponds to the JSON property evenPageHeaderId

Returns:

  • (String) 


4482
4483
4484
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4482

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 is 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) 


4493
4494
4495
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4493

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 is 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) 


4504
4505
4506
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4504

def first_page_header_id
  @first_page_header_id
end

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

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

Returns:



4509
4510
4511
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4509

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:



4514
4515
4516
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4514

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:



4519
4520
4521
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4519

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:



4524
4525
4526
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4524

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:



4529
4530
4531
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4529

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:



4534
4535
4536
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4534

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) 


4543
4544
4545
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4543

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) 


4548
4549
4550
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4548

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) 


4558
4559
4560
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4558

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4566

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)
  @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