Class: Google::Apis::DocsV1::SectionStyle
- Inherits:
-
Object
- Object
- Google::Apis::DocsV1::SectionStyle
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/docs_v1/classes.rb,
generated/google/apis/docs_v1/representations.rb,
generated/google/apis/docs_v1/representations.rb
Overview
The styling that applies to a section.
Instance Attribute Summary collapse
-
#column_properties ⇒ Array<Google::Apis::DocsV1::SectionColumnProperties>
The section's columns properties.
-
#column_separator_style ⇒ String
The style of column separators.
-
#content_direction ⇒ String
The content direction of this section.
-
#default_footer_id ⇒ String
The ID of the default footer.
-
#default_header_id ⇒ String
The ID of the default header.
-
#even_page_footer_id ⇒ String
The ID of the footer used only for even pages.
-
#even_page_header_id ⇒ String
The ID of the header used only for even pages.
-
#first_page_footer_id ⇒ String
The ID of the footer used only for the first page of the section.
-
#first_page_header_id ⇒ String
The ID of the header used only for the first page of the section.
-
#margin_bottom ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#margin_footer ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#margin_header ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#margin_left ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#margin_right ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#margin_top ⇒ Google::Apis::DocsV1::Dimension
A magnitude in a single direction in the specified units.
-
#page_number_start ⇒ Fixnum
The page number from which to start counting the number of pages for this section.
-
#section_type ⇒ String
Output only.
-
#use_first_page_header_footer ⇒ Boolean
(also: #use_first_page_header_footer?)
Indicates whether to use the first page header / footer IDs for the first page of the section.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SectionStyle
constructor
A new instance of SectionStyle.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SectionStyle
Returns a new instance of SectionStyle.
4575 4576 4577 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4575 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
4425 4426 4427 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4425 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
4433 4434 4435 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4433 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
4441 4442 4443 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4441 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
4450 4451 4452 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4450 def @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
4459 4460 4461 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4459 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
4473 4474 4475 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4473 def @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
4487 4488 4489 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4487 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
4501 4502 4503 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4501 def @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
4515 4516 4517 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4515 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
4520 4521 4522 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4520 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
4525 4526 4527 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4525 def @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
4530 4531 4532 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4530 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
4535 4536 4537 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4535 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
4540 4541 4542 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4540 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
4545 4546 4547 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4545 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
4556 4557 4558 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4556 def page_number_start @page_number_start end |
#section_type ⇒ String
Output only. The type of section.
Corresponds to the JSON property sectionType
4561 4562 4563 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4561 def section_type @section_type end |
#use_first_page_header_footer ⇒ Boolean Also known as:
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
4572 4573 4574 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4572 def @use_first_page_header_footer end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 |
# File 'generated/google/apis/docs_v1/classes.rb', line 4580 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 |