Class: Google::Apis::DocsV1::DocumentStyle

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 style of the document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DocumentStyle

Returns a new instance of DocumentStyle.



1112
1113
1114
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1112

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

Returns:



996
997
998
 
# File 'lib/google/apis/docs_v1/classes.rb', line 996

def background
  @background
end

#default_footer_id ⇒ String

The ID of the default footer. If not set, there's no default footer. This property is read-only. Corresponds to the JSON property defaultFooterId

Returns:

  • (String) 


1002
1003
1004
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1002

def default_footer_id
  @default_footer_id
end

#default_header_id ⇒ String

The ID of the default header. If not set, there's no default header. This property is read-only. Corresponds to the JSON property defaultHeaderId

Returns:

  • (String) 


1008
1009
1010
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1008

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's no even page footer. This property is read-only. Corresponds to the JSON property evenPageFooterId

Returns:

  • (String) 


1016
1017
1018
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1016

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. 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's no even page header. This property is read-only. Corresponds to the JSON property evenPageHeaderId

Returns:

  • (String) 


1024
1025
1026
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1024

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's no first page footer. This property is read-only. Corresponds to the JSON property firstPageFooterId

Returns:

  • (String) 


1033
1034
1035
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1033

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. 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's no first page header. This property is read-only. Corresponds to the JSON property firstPageHeaderId

Returns:

  • (String) 


1042
1043
1044
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1042

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 the page_size, which allows changing the page orientation between portrait and landscape. Corresponds to the JSON property flipPageOrientation

Returns:

  • (Boolean) 


1048
1049
1050
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1048

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:



1054
1055
1056
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1054

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:



1059
1060
1061
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1059

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:



1064
1065
1066
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1064

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:



1069
1070
1071
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1069

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:



1074
1075
1076
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1074

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:



1079
1080
1081
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1079

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

Returns:

  • (Fixnum) 


1084
1085
1086
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1084

def page_number_start
  @page_number_start
end

#page_size ⇒ Google::Apis::DocsV1::Size

A width and height. Corresponds to the JSON property pageSize

Returns:



1089
1090
1091
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1089

def page_size
  @page_size
end

#use_custom_header_footer_margins ⇒ Boolean Also known as: use_custom_header_footer_margins?

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

Returns:

  • (Boolean) 


1097
1098
1099
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1097

def use_custom_header_footer_margins
  @use_custom_header_footer_margins
end

#use_even_page_header_footer ⇒ Boolean Also known as: use_even_page_header_footer?

Indicates whether to use the even page header / footer IDs for the even pages. Corresponds to the JSON property useEvenPageHeaderFooter

Returns:

  • (Boolean) 


1103
1104
1105
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1103

def use_even_page_header_footer
  @use_even_page_header_footer
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. Corresponds to the JSON property useFirstPageHeaderFooter

Returns:

  • (Boolean) 


1109
1110
1111
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1109

def use_first_page_header_footer
  @use_first_page_header_footer
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/google/apis/docs_v1/classes.rb', line 1117

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