Class: Google::Apis::DocsV1::DocumentStyle
- Inherits:
-
Object
- Object
- Google::Apis::DocsV1::DocumentStyle
- 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 style of the document.
Instance Attribute Summary collapse
-
#background ⇒ Google::Apis::DocsV1::Background
Represents the background of a document.
-
#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.
-
#first_page_header_id ⇒ String
The ID of the header used only for the first page.
-
#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.
-
#page_size ⇒ Google::Apis::DocsV1::Size
A width and height.
-
#use_custom_header_footer_margins ⇒ Boolean
(also: #use_custom_header_footer_margins?)
Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected.
-
#use_even_page_header_footer ⇒ Boolean
(also: #use_even_page_header_footer?)
Indicates whether to use the even page header / footer IDs for the even pages.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ DocumentStyle
constructor
A new instance of DocumentStyle.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ DocumentStyle
Returns a new instance of DocumentStyle.
1158 1159 1160 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1158 def initialize(**args) update!(**args) end |
Instance Attribute Details
#background ⇒ Google::Apis::DocsV1::Background
Represents the background of a document.
Corresponds to the JSON property background
1036 1037 1038 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1036 def background @background end |
#default_footer_id ⇒ String
The ID of the default footer. If not set, there is no default footer.
This property is read-only.
Corresponds to the JSON property defaultFooterId
1042 1043 1044 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1042 def @default_footer_id end |
#default_header_id ⇒ String
The ID of the default header. If not set, there is no default header.
This property is read-only.
Corresponds to the JSON property defaultHeaderId
1048 1049 1050 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1048 def default_header_id @default_header_id end |
#even_page_footer_id ⇒ String
The ID of the footer used only for even pages. The value of
use_even_page_header_footer determines
whether to use the default_footer_id or this value for the
footer on even pages. If not set, there is no even page footer.
This property is read-only.
Corresponds to the JSON property evenPageFooterId
1057 1058 1059 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1057 def @even_page_footer_id end |
#even_page_header_id ⇒ String
The ID of the header used only for even pages. The value of
use_even_page_header_footer determines
whether to use the default_header_id or this value for the
header on even pages. If not set, there is no even page header.
This property is read-only.
Corresponds to the JSON property evenPageHeaderId
1066 1067 1068 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1066 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. If not set then
a unique footer for the first page does not exist. The value of
use_first_page_header_footer determines
whether to use the default_footer_id or this value for the
footer on the first page. If not set, there is no first page footer.
This property is read-only.
Corresponds to the JSON property firstPageFooterId
1076 1077 1078 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1076 def @first_page_footer_id end |
#first_page_header_id ⇒ String
The ID of the header used only for the first page. If not set then
a unique header for the first page does not exist.
The value of use_first_page_header_footer determines
whether to use the default_header_id or this value for the
header on the first page. If not set, there is no first page header.
This property is read-only.
Corresponds to the JSON property firstPageHeaderId
1086 1087 1088 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1086 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
1091 1092 1093 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1091 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
1096 1097 1098 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1096 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
1101 1102 1103 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1101 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
1106 1107 1108 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1106 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
1111 1112 1113 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1111 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
1116 1117 1118 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1116 def margin_top @margin_top end |
#page_number_start ⇒ Fixnum
The page number from which to start counting the number of pages.
Corresponds to the JSON property pageNumberStart
1121 1122 1123 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1121 def page_number_start @page_number_start end |
#page_size ⇒ Google::Apis::DocsV1::Size
A width and height.
Corresponds to the JSON property pageSize
1126 1127 1128 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1126 def page_size @page_size end |
#use_custom_header_footer_margins ⇒ Boolean Also known as:
Indicates whether DocumentStyle
margin_header,
SectionStyle
margin_header and
DocumentStyle
margin_footer,
SectionStyle
margin_footer are
respected. When false, the default values in the Docs editor for header and
footer margin are used.
This property is read-only.
Corresponds to the JSON property useCustomHeaderFooterMargins
1141 1142 1143 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1141 def @use_custom_header_footer_margins end |
#use_even_page_header_footer ⇒ Boolean Also known as:
Indicates whether to use the even page header / footer IDs for the even
pages.
Corresponds to the JSON property useEvenPageHeaderFooter
1148 1149 1150 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1148 def @use_even_page_header_footer end |
#use_first_page_header_footer ⇒ Boolean Also known as:
Indicates whether to use the first page header / footer IDs for the first
page.
Corresponds to the JSON property useFirstPageHeaderFooter
1155 1156 1157 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1155 def @use_first_page_header_footer end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 |
# File 'generated/google/apis/docs_v1/classes.rb', line 1163 def update!(**args) @background = args[:background] if args.key?(:background) @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) @page_size = args[:page_size] if args.key?(:page_size) @use_custom_header_footer_margins = args[:use_custom_header_footer_margins] if args.key?(:use_custom_header_footer_margins) @use_even_page_header_footer = args[:use_even_page_header_footer] if args.key?(:use_even_page_header_footer) @use_first_page_header_footer = args[:use_first_page_header_footer] if args.key?(:use_first_page_header_footer) end |