Class: Axlsx::App

Inherits:
Object
  • Object
show all
Includes:
OptionsParser
Defined in:
lib/axlsx/doc_props/app.rb

Overview

Note:

Support is not implemented for the following complex types:

HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks (VectorVariant), DigSig (DigSigBlob)

App represents the app.xml document. The attributes for this object are primarily managed by the application the end user uses to edit the document. None of the attributes are required to serialize a valid xlsx object.

See Also:

  • shared-documentPropertiesExtendedshared-documentPropertiesExtended.xsd

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(options = {}) ⇒ App

Creates an App object

Options Hash (options):

  • template (String)
  • manager (String)
  • pages (Integer)
  • words (Integer)
  • characters (Integer)
  • presentation_format (String)
  • lines (Integer)
  • paragraphs (Integer)
  • slides (Integer)
  • notes (Integer)
  • total_time (Integer)
  • hidden_slides (Integer)
  • m_m_clips (Integer)
  • scale_crop (Boolean)
  • links_up_to_date (Boolean)
  • characters_with_spaces (Integer)
  • share_doc (Boolean)
  • hyperlink_base (String)
  • hyperlinks_changed (String)
  • application (String)
  • app_version (String)
  • doc_security (Integer) 


39
40
41
 
# File 'lib/axlsx/doc_props/app.rb', line 39

def initialize(options={})
  parse_options options
end

Instance Attribute Details

#app_version ⇒ String Also known as: AppVersion 



128
129
130
 
# File 'lib/axlsx/doc_props/app.rb', line 128

def app_version
  @app_version
end

#application ⇒ String (readonly) Also known as: Applicatoin 



124
125
126
 
# File 'lib/axlsx/doc_props/app.rb', line 124

def application
  @application
end

#characters ⇒ Integer Also known as: Characters 



64
65
66
 
# File 'lib/axlsx/doc_props/app.rb', line 64

def characters
  @characters
end

#characters_with_spaces ⇒ Integer Also known as: CharactersWithSpaces 



108
109
110
 
# File 'lib/axlsx/doc_props/app.rb', line 108

def characters_with_spaces
  @characters_with_spaces
end

#company ⇒ String Also known as: Company 



52
53
54
 
# File 'lib/axlsx/doc_props/app.rb', line 52

def company
  @company
end

#doc_security ⇒ Integer Also known as: DocSecurity 



132
133
134
 
# File 'lib/axlsx/doc_props/app.rb', line 132

def doc_security
  @doc_security
end

#hidden_slides ⇒ Integer Also known as: HiddenSlides 



92
93
94
 
# File 'lib/axlsx/doc_props/app.rb', line 92

def hidden_slides
  @hidden_slides
end

#hyperlink_base ⇒ String Also known as: HyperlinkBase 



116
117
118
 
# File 'lib/axlsx/doc_props/app.rb', line 116

def hyperlink_base
  @hyperlink_base
end

#hyperlinks_changed ⇒ Boolean Also known as: HyperlinksChanged 



120
121
122
 
# File 'lib/axlsx/doc_props/app.rb', line 120

def hyperlinks_changed
  @hyperlinks_changed
end

#lines ⇒ Integer Also known as: Lines 



72
73
74
 
# File 'lib/axlsx/doc_props/app.rb', line 72

def lines
  @lines
end

#links_up_to_date ⇒ Boolean Also known as: LinksUpToDate 



104
105
106
 
# File 'lib/axlsx/doc_props/app.rb', line 104

def links_up_to_date
  @links_up_to_date
end

#m_m_clips ⇒ Integer Also known as: MMClips 



96
97
98
 
# File 'lib/axlsx/doc_props/app.rb', line 96

def m_m_clips
  @m_m_clips
end

#manager ⇒ String Also known as: Manager 



48
49
50
 
# File 'lib/axlsx/doc_props/app.rb', line 48

def manager
  @manager
end

#notes ⇒ Integer Also known as: Notes 



84
85
86
 
# File 'lib/axlsx/doc_props/app.rb', line 84

def notes
  @notes
end

#pages ⇒ Integer Also known as: Pages 



56
57
58
 
# File 'lib/axlsx/doc_props/app.rb', line 56

def pages
  @pages
end

#paragraphs ⇒ Integer Also known as: Paragraphs 



76
77
78
 
# File 'lib/axlsx/doc_props/app.rb', line 76

def paragraphs
  @paragraphs
end

#presentation_format ⇒ String Also known as: PresentationFormat 



68
69
70
 
# File 'lib/axlsx/doc_props/app.rb', line 68

def presentation_format
  @presentation_format
end

#scale_crop ⇒ Boolean Also known as: ScaleCrop 



100
101
102
 
# File 'lib/axlsx/doc_props/app.rb', line 100

def scale_crop
  @scale_crop
end

#shared_doc ⇒ Boolean Also known as: SharedDoc 



112
113
114
 
# File 'lib/axlsx/doc_props/app.rb', line 112

def shared_doc
  @shared_doc
end

#slides ⇒ Intger Also known as: Slides 



80
81
82
 
# File 'lib/axlsx/doc_props/app.rb', line 80

def slides
  @slides
end

#template ⇒ String Also known as: Template 



44
45
46
 
# File 'lib/axlsx/doc_props/app.rb', line 44

def template
  @template
end

#total_time ⇒ Integer Also known as: TotalTime 



88
89
90
 
# File 'lib/axlsx/doc_props/app.rb', line 88

def total_time
  @total_time
end

#words ⇒ Integer Also known as: Words 



60
61
62
 
# File 'lib/axlsx/doc_props/app.rb', line 60

def words
  @words
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serialize the app.xml document



223
224
225
226
227
228
229
230
231
 
# File 'lib/axlsx/doc_props/app.rb', line 223

def to_xml_string(str = '')
  str << '<?xml version="1.0" encoding="UTF-8"?>'
  str << '<Properties xmlns="' << APP_NS << '" xmlns:vt="' << APP_NS_VT << '">'
  instance_values.each do |key, value|
    node_name = Axlsx.camel(key)
    str << "<#{node_name}>#{value}</#{node_name}>"
  end
  str << '</Properties>'
end