Class: AsposeWordsCloud::Style
- Inherits:
-
Object
- Object
- AsposeWordsCloud::Style
- Defined in:
- lib/aspose_words_cloud/models/style.rb
Overview
DTO container with a single document style.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#aliases ⇒ Object
Gets or sets all aliases of this style.
-
#base_style_name ⇒ Object
Gets or sets the name of the style this style is based on.
-
#built_in ⇒ Object
Gets or sets a value indicating whether this style is one of the built-in styles in MS Word.
-
#font ⇒ Object
Gets or sets the character formatting of the style.
-
#is_heading ⇒ Object
Gets or sets a value indicating whether the style is one of the built-in Heading styles.
-
#is_quick_style ⇒ Object
Gets or sets a value indicating whether this style is shown in the Quick Style gallery inside MS Word UI.
-
#link ⇒ Object
Gets or sets the link to the document.
-
#linked_style_name ⇒ Object
Gets or sets the name of the Style linked to this one.
-
#name ⇒ Object
Gets or sets the name of the style.
-
#next_paragraph_style_name ⇒ Object
Gets or sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
-
#style_identifier ⇒ Object
Gets or sets the locale independent style identifier for a built-in style.
-
#type ⇒ Object
Gets or sets the style type (paragraph or character).
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Style
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Style
Initializes the object
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/aspose_words_cloud/models/style.rb', line 128 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.key?(:'Link') self.link = attributes[:'Link'] end if attributes.key?(:'Aliases') if (value = attributes[:'Aliases']).is_a?(Array) self.aliases = value end end if attributes.key?(:'BaseStyleName') self.base_style_name = attributes[:'BaseStyleName'] end if attributes.key?(:'BuiltIn') self.built_in = attributes[:'BuiltIn'] end if attributes.key?(:'Font') self.font = attributes[:'Font'] end if attributes.key?(:'IsHeading') self.is_heading = attributes[:'IsHeading'] end if attributes.key?(:'IsQuickStyle') self.is_quick_style = attributes[:'IsQuickStyle'] end if attributes.key?(:'LinkedStyleName') self.linked_style_name = attributes[:'LinkedStyleName'] end if attributes.key?(:'Name') self.name = attributes[:'Name'] end if attributes.key?(:'NextParagraphStyleName') self.next_paragraph_style_name = attributes[:'NextParagraphStyleName'] end if attributes.key?(:'StyleIdentifier') self.style_identifier = attributes[:'StyleIdentifier'] end if attributes.key?(:'Type') self.type = attributes[:'Type'] end end |
Instance Attribute Details
#aliases ⇒ Object
Gets or sets all aliases of this style. If style has no aliases then empty array of string is returned.
36 37 38 |
# File 'lib/aspose_words_cloud/models/style.rb', line 36 def aliases @aliases end |
#base_style_name ⇒ Object
Gets or sets the name of the style this style is based on.
39 40 41 |
# File 'lib/aspose_words_cloud/models/style.rb', line 39 def base_style_name @base_style_name end |
#built_in ⇒ Object
Gets or sets a value indicating whether this style is one of the built-in styles in MS Word.
42 43 44 |
# File 'lib/aspose_words_cloud/models/style.rb', line 42 def built_in @built_in end |
#font ⇒ Object
Gets or sets the character formatting of the style.
45 46 47 |
# File 'lib/aspose_words_cloud/models/style.rb', line 45 def font @font end |
#is_heading ⇒ Object
Gets or sets a value indicating whether the style is one of the built-in Heading styles.
48 49 50 |
# File 'lib/aspose_words_cloud/models/style.rb', line 48 def is_heading @is_heading end |
#is_quick_style ⇒ Object
Gets or sets a value indicating whether this style is shown in the Quick Style gallery inside MS Word UI.
51 52 53 |
# File 'lib/aspose_words_cloud/models/style.rb', line 51 def is_quick_style @is_quick_style end |
#link ⇒ Object
Gets or sets the link to the document.
33 34 35 |
# File 'lib/aspose_words_cloud/models/style.rb', line 33 def link @link end |
#linked_style_name ⇒ Object
Gets or sets the name of the Style linked to this one. Returns Empty string if no styles are linked.
54 55 56 |
# File 'lib/aspose_words_cloud/models/style.rb', line 54 def linked_style_name @linked_style_name end |
#name ⇒ Object
Gets or sets the name of the style.
57 58 59 |
# File 'lib/aspose_words_cloud/models/style.rb', line 57 def name @name end |
#next_paragraph_style_name ⇒ Object
Gets or sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
60 61 62 |
# File 'lib/aspose_words_cloud/models/style.rb', line 60 def next_paragraph_style_name @next_paragraph_style_name end |
#style_identifier ⇒ Object
Gets or sets the locale independent style identifier for a built-in style.
63 64 65 |
# File 'lib/aspose_words_cloud/models/style.rb', line 63 def style_identifier @style_identifier end |
#type ⇒ Object
Gets or sets the style type (paragraph or character).
66 67 68 |
# File 'lib/aspose_words_cloud/models/style.rb', line 66 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/aspose_words_cloud/models/style.rb', line 91 def self.attribute_map { :'link' => :'Link', :'aliases' => :'Aliases', :'base_style_name' => :'BaseStyleName', :'built_in' => :'BuiltIn', :'font' => :'Font', :'is_heading' => :'IsHeading', :'is_quick_style' => :'IsQuickStyle', :'linked_style_name' => :'LinkedStyleName', :'name' => :'Name', :'next_paragraph_style_name' => :'NextParagraphStyleName', :'style_identifier' => :'StyleIdentifier', :'type' => :'Type' } end |
.swagger_types ⇒ Object
Attribute type mapping.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/aspose_words_cloud/models/style.rb', line 109 def self.swagger_types { :'link' => :'WordsApiLink', :'aliases' => :'Array<String>', :'base_style_name' => :'String', :'built_in' => :'BOOLEAN', :'font' => :'Font', :'is_heading' => :'BOOLEAN', :'is_quick_style' => :'BOOLEAN', :'linked_style_name' => :'String', :'name' => :'String', :'next_paragraph_style_name' => :'String', :'style_identifier' => :'String', :'type' => :'String' } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/aspose_words_cloud/models/style.rb', line 234 def ==(other) return true if self.equal?(other) self.class == other.class && link == other.link && aliases == other.aliases && base_style_name == other.base_style_name && built_in == other.built_in && font == other.font && is_heading == other.is_heading && is_quick_style == other.is_quick_style && linked_style_name == other.linked_style_name && name == other.name && next_paragraph_style_name == other.next_paragraph_style_name && style_identifier == other.style_identifier && type == other.type end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/aspose_words_cloud/models/style.rb', line 288 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = AsposeWordsCloud.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/aspose_words_cloud/models/style.rb', line 355 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/aspose_words_cloud/models/style.rb', line 266 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
253 254 255 |
# File 'lib/aspose_words_cloud/models/style.rb', line 253 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
259 260 261 |
# File 'lib/aspose_words_cloud/models/style.rb', line 259 def hash [link, aliases, base_style_name, built_in, font, is_heading, is_quick_style, linked_style_name, name, next_paragraph_style_name, style_identifier, type].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
187 188 189 190 |
# File 'lib/aspose_words_cloud/models/style.rb', line 187 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
335 336 337 |
# File 'lib/aspose_words_cloud/models/style.rb', line 335 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
341 342 343 344 345 346 347 348 349 |
# File 'lib/aspose_words_cloud/models/style.rb', line 341 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
329 330 331 |
# File 'lib/aspose_words_cloud/models/style.rb', line 329 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
194 195 196 197 198 199 200 201 |
# File 'lib/aspose_words_cloud/models/style.rb', line 194 def valid? style_identifier_validator = EnumAttributeValidator.new('String', ["Normal", "Heading1", "Heading2", "Heading3", "Heading4", "Heading5", "Heading6", "Heading7", "Heading8", "Heading9", "Index1", "Index2", "Index3", "Index4", "Index5", "Index6", "Index7", "Index8", "Index9", "Toc1", "Toc2", "Toc3", "Toc4", "Toc5", "Toc6", "Toc7", "Toc8", "Toc9", "NormalIndent", "FootnoteText", "CommentText", "Header", "Footer", "IndexHeading", "Caption", "TableOfFigures", "EnvelopeAddress", "EnvelopeReturn", "FootnoteReference", "CommentReference", "LineNumber", "PageNumber", "EndnoteReference", "EndnoteText", "TableOfAuthorities", "Macro", "ToaHeading", "List", "ListBullet", "ListNumber", "List2", "List3", "List4", "List5", "ListBullet2", "ListBullet3", "ListBullet4", "ListBullet5", "ListNumber2", "ListNumber3", "ListNumber4", "ListNumber5", "Title", "Closing", "Signature", "DefaultParagraphFont", "BodyText", "BodyTextInd", "ListContinue", "ListContinue2", "ListContinue3", "ListContinue4", "ListContinue5", "MessageHeader", "Subtitle", "Salutation", "Date", "BodyText1I", "BodyText1I2", "NoteHeading", "BodyText2", "BodyText3", "BodyTextInd2", "BodyTextInd3", "BlockText", "Hyperlink", "FollowedHyperlink", "Strong", "Emphasis", "DocumentMap", "PlainText", "EmailSignature", "HtmlTopOfForm", "HtmlBottomOfForm", "NormalWeb", "HtmlAcronym", "HtmlAddress", "HtmlCite", "HtmlCode", "HtmlDefinition", "HtmlKeyboard", "HtmlPreformatted", "HtmlSample", "HtmlTypewriter", "HtmlVariable", "TableNormal", "CommentSubject", "NoList", "OutlineList1", "OutlineList2", "OutlineList3", "TableSimple1", "TableSimple2", "TableSimple3", "TableClassic1", "TableClassic2", "TableClassic3", "TableClassic4", "TableColorful1", "TableColorful2", "TableColorful3", "TableColumns1", "TableColumns2", "TableColumns3", "TableColumns4", "TableColumns5", "TableGrid1", "TableGrid2", "TableGrid3", "TableGrid4", "TableGrid5", "TableGrid6", "TableGrid7", "TableGrid8", "TableList1", "TableList2", "TableList3", "TableList4", "TableList5", "TableList6", "TableList7", "TableList8", "Table3DEffects1", "Table3DEffects2", "Table3DEffects3", "TableContemporary", "TableElegant", "TableProfessional", "TableSubtle1", "TableSubtle2", "TableWeb1", "TableWeb2", "TableWeb3", "BalloonText", "TableGrid", "TableTheme", "PlaceholderText", "NoSpacing", "LightShading", "LightList", "LightGrid", "MediumShading1", "MediumShading2", "MediumList1", "MediumList2", "MediumGrid1", "MediumGrid2", "MediumGrid3", "DarkList", "ColorfulShading", "ColorfulList", "ColorfulGrid", "LightShadingAccent1", "LightListAccent1", "LightGridAccent1", "MediumShading1Accent1", "MediumShading2Accent1", "MediumList1Accent1", "Revision", "ListParagraph", "Quote", "IntenseQuote", "MediumList2Accent1", "MediumGrid1Accent1", "MediumGrid2Accent1", "MediumGrid3Accent1", "DarkListAccent1", "ColorfulShadingAccent1", "ColorfulListAccent1", "ColorfulGridAccent1", "LightShadingAccent2", "LightListAccent2", "LightGridAccent2", "MediumShading1Accent2", "MediumShading2Accent2", "MediumList1Accent2", "MediumList2Accent2", "MediumGrid1Accent2", "MediumGrid2Accent2", "MediumGrid3Accent2", "DarkListAccent2", "ColorfulShadingAccent2", "ColorfulListAccent2", "ColorfulGridAccent2", "LightShadingAccent3", "LightListAccent3", "LightGridAccent3", "MediumShading1Accent3", "MediumShading2Accent3", "MediumList1Accent3", "MediumList2Accent3", "MediumGrid1Accent3", "MediumGrid2Accent3", "MediumGrid3Accent3", "DarkListAccent3", "ColorfulShadingAccent3", "ColorfulListAccent3", "ColorfulGridAccent3", "LightShadingAccent4", "LightListAccent4", "LightGridAccent4", "MediumShading1Accent4", "MediumShading2Accent4", "MediumList1Accent4", "MediumList2Accent4", "MediumGrid1Accent4", "MediumGrid2Accent4", "MediumGrid3Accent4", "DarkListAccent4", "ColorfulShadingAccent4", "ColorfulListAccent4", "ColorfulGridAccent4", "LightShadingAccent5", "LightListAccent5", "LightGridAccent5", "MediumShading1Accent5", "MediumShading2Accent5", "MediumList1Accent5", "MediumList2Accent5", "MediumGrid1Accent5", "MediumGrid2Accent5", "MediumGrid3Accent5", "DarkListAccent5", "ColorfulShadingAccent5", "ColorfulListAccent5", "ColorfulGridAccent5", "LightShadingAccent6", "LightListAccent6", "LightGridAccent6", "MediumShading1Accent6", "MediumShading2Accent6", "MediumList1Accent6", "MediumList2Accent6", "MediumGrid1Accent6", "MediumGrid2Accent6", "MediumGrid3Accent6", "DarkListAccent6", "ColorfulShadingAccent6", "ColorfulListAccent6", "ColorfulGridAccent6", "SubtleEmphasis", "IntenseEmphasis", "SubtleReference", "IntenseReference", "BookTitle", "Bibliography", "TocHeading", "PlainTable1", "PlainTable2", "PlainTable3", "PlainTable4", "PlainTable5", "TableGridLight", "GridTable1Light", "GridTable2", "GridTable3", "GridTable4", "GridTable5Dark", "GridTable6Colorful", "GridTable7Colorful", "GridTable1LightAccent1", "GridTable2Accent1", "GridTable3Accent1", "GridTable4Accent1", "GridTable5DarkAccent1", "GridTable6ColorfulAccent1", "GridTable7ColorfulAccent1", "GridTable1LightAccent2", "GridTable2Accent2", "GridTable3Accent2", "GridTable4Accent2", "GridTable5DarkAccent2", "GridTable6ColorfulAccent2", "GridTable7ColorfulAccent2", "GridTable1LightAccent3", "GridTable2Accent3", "GridTable3Accent3", "GridTable4Accent3", "GridTable5DarkAccent3", "GridTable6ColorfulAccent3", "GridTable7ColorfulAccent3", "GridTable1LightAccent4", "GridTable2Accent4", "GridTable3Accent4", "GridTable4Accent4", "GridTable5DarkAccent4", "GridTable6ColorfulAccent4", "GridTable7ColorfulAccent4", "GridTable1LightAccent5", "GridTable2Accent5", "GridTable3Accent5", "GridTable4Accent5", "GridTable5DarkAccent5", "GridTable6ColorfulAccent5", "GridTable7ColorfulAccent5", "GridTable1LightAccent6", "GridTable2Accent6", "GridTable3Accent6", "GridTable4Accent6", "GridTable5DarkAccent6", "GridTable6ColorfulAccent6", "GridTable7ColorfulAccent6", "ListTable1Light", "ListTable2", "ListTable3", "ListTable4", "ListTable5Dark", "ListTable6Colorful", "ListTable7Colorful", "ListTable1LightAccent1", "ListTable2Accent1", "ListTable3Accent1", "ListTable4Accent1", "ListTable5DarkAccent1", "ListTable6ColorfulAccent1", "ListTable7ColorfulAccent1", "ListTable1LightAccent2", "ListTable2Accent2", "ListTable3Accent2", "ListTable4Accent2", "ListTable5DarkAccent2", "ListTable6ColorfulAccent2", "ListTable7ColorfulAccent2", "ListTable1LightAccent3", "ListTable2Accent3", "ListTable3Accent3", "ListTable4Accent3", "ListTable5DarkAccent3", "ListTable6ColorfulAccent3", "ListTable7ColorfulAccent3", "ListTable1LightAccent4", "ListTable2Accent4", "ListTable3Accent4", "ListTable4Accent4", "ListTable5DarkAccent4", "ListTable6ColorfulAccent4", "ListTable7ColorfulAccent4", "ListTable1LightAccent5", "ListTable2Accent5", "ListTable3Accent5", "ListTable4Accent5", "ListTable5DarkAccent5", "ListTable6ColorfulAccent5", "ListTable7ColorfulAccent5", "ListTable1LightAccent6", "ListTable2Accent6", "ListTable3Accent6", "ListTable4Accent6", "ListTable5DarkAccent6", "ListTable6ColorfulAccent6", "ListTable7ColorfulAccent6", "User", "Nil"]) return false unless style_identifier_validator.valid?(@style_identifier) type_validator = EnumAttributeValidator.new('String', ["Paragraph", "Character", "Table", "List"]) return false unless type_validator.valid?(@type) return true end |