Class: Axlsx::App
- Inherits:
-
Object
- Object
- Axlsx::App
- Defined in:
- lib/axlsx/doc_props/app.rb
Overview
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.
Instance Attribute Summary collapse
-
#app_version ⇒ String
(also: #AppVersion)
The version of the application.
-
#application ⇒ String
(also: #Applicatoin)
readonly
The name of the application.
-
#characters ⇒ Integer
(also: #Characters)
The number of characters in the document.
-
#characters_with_spaces ⇒ Integer
(also: #CharactersWithSpaces)
The number of characters in the document including spaces.
-
#company ⇒ String
(also: #Company)
The name of the company generating the document.
-
#doc_security ⇒ Integer
(also: #DocSecurity)
Document security.
-
#hidden_slides ⇒ Integer
(also: #HiddenSlides)
The number of hidden slides.
-
#hyperlink_base ⇒ String
(also: #HyperlinkBase)
The base for hyper links in the document.
-
#hyperlinks_changed ⇒ Boolean
(also: #HyperlinksChanged)
Indicates that the hyper links in the document have been changed.
-
#lines ⇒ Integer
(also: #Lines)
The number of lines in the document.
-
#links_up_to_date ⇒ Boolean
(also: #LinksUpToDate)
The links in the document are up to date.
-
#m_m_clips ⇒ Integer
(also: #MMClips)
The total number multimedia clips.
-
#manager ⇒ String
(also: #Manager)
The name of the manager for the document.
-
#notes ⇒ Integer
(also: #Notes)
The number of slides that have notes.
-
#pages ⇒ Integer
(also: #Pages)
The number of pages in the document.
-
#paragraphs ⇒ Integer
(also: #Paragraphs)
The number of paragraphs in the document.
-
#presentation_format ⇒ String
(also: #PresentationFormat)
The intended format of the presentation.
-
#scale_crop ⇒ Boolean
(also: #ScaleCrop)
The display mode for the document thumbnail.
-
#shared_doc ⇒ Boolean
(also: #SharedDoc)
Indicates if the document is shared.
-
#slides ⇒ Intger
(also: #Slides)
The number of slides in the document.
-
#template ⇒ String
(also: #Template)
The name of the document template.
-
#total_time ⇒ Integer
(also: #TotalTime)
The total amount of time spent editing.
-
#words ⇒ Integer
(also: #Words)
The number of words in the document.
Instance Method Summary collapse
-
#initialize(options = {}) ⇒ App
constructor
Creates an App object.
-
#to_xml_string(str = '') ⇒ String
Serialize the app.xml document.
Constructor Details
#initialize(options = {}) ⇒ App
Creates an App object
128 129 130 131 132 |
# File 'lib/axlsx/doc_props/app.rb', line 128 def initialize(={}) .each do |o| self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" end end |
Instance Attribute Details
#app_version ⇒ String Also known as: AppVersion
Returns The version of the application.
98 99 100 |
# File 'lib/axlsx/doc_props/app.rb', line 98 def app_version @app_version end |
#application ⇒ String (readonly) Also known as: Applicatoin
Returns The name of the application.
94 95 96 |
# File 'lib/axlsx/doc_props/app.rb', line 94 def application @application end |
#characters ⇒ Integer Also known as: Characters
Returns The number of characters in the document.
34 35 36 |
# File 'lib/axlsx/doc_props/app.rb', line 34 def characters @characters end |
#characters_with_spaces ⇒ Integer Also known as: CharactersWithSpaces
Returns The number of characters in the document including spaces.
78 79 80 |
# File 'lib/axlsx/doc_props/app.rb', line 78 def characters_with_spaces @characters_with_spaces end |
#company ⇒ String Also known as: Company
Returns The name of the company generating the document.
22 23 24 |
# File 'lib/axlsx/doc_props/app.rb', line 22 def company @company end |
#doc_security ⇒ Integer Also known as: DocSecurity
Returns Document security.
102 103 104 |
# File 'lib/axlsx/doc_props/app.rb', line 102 def doc_security @doc_security end |
#hidden_slides ⇒ Integer Also known as: HiddenSlides
Returns The number of hidden slides.
62 63 64 |
# File 'lib/axlsx/doc_props/app.rb', line 62 def @hidden_slides end |
#hyperlink_base ⇒ String Also known as: HyperlinkBase
Returns The base for hyper links in the document.
86 87 88 |
# File 'lib/axlsx/doc_props/app.rb', line 86 def hyperlink_base @hyperlink_base end |
#hyperlinks_changed ⇒ Boolean Also known as: HyperlinksChanged
Returns Indicates that the hyper links in the document have been changed.
90 91 92 |
# File 'lib/axlsx/doc_props/app.rb', line 90 def hyperlinks_changed @hyperlinks_changed end |
#lines ⇒ Integer Also known as: Lines
Returns The number of lines in the document.
42 43 44 |
# File 'lib/axlsx/doc_props/app.rb', line 42 def lines @lines end |
#links_up_to_date ⇒ Boolean Also known as: LinksUpToDate
Returns The links in the document are up to date.
74 75 76 |
# File 'lib/axlsx/doc_props/app.rb', line 74 def links_up_to_date @links_up_to_date end |
#m_m_clips ⇒ Integer Also known as: MMClips
Returns The total number multimedia clips.
66 67 68 |
# File 'lib/axlsx/doc_props/app.rb', line 66 def m_m_clips @m_m_clips end |
#manager ⇒ String Also known as: Manager
Returns The name of the manager for the document.
18 19 20 |
# File 'lib/axlsx/doc_props/app.rb', line 18 def manager @manager end |
#notes ⇒ Integer Also known as: Notes
Returns The number of slides that have notes.
54 55 56 |
# File 'lib/axlsx/doc_props/app.rb', line 54 def notes @notes end |
#pages ⇒ Integer Also known as: Pages
Returns The number of pages in the document.
26 27 28 |
# File 'lib/axlsx/doc_props/app.rb', line 26 def pages @pages end |
#paragraphs ⇒ Integer Also known as: Paragraphs
Returns The number of paragraphs in the document.
46 47 48 |
# File 'lib/axlsx/doc_props/app.rb', line 46 def paragraphs @paragraphs end |
#presentation_format ⇒ String Also known as: PresentationFormat
Returns The intended format of the presentation.
38 39 40 |
# File 'lib/axlsx/doc_props/app.rb', line 38 def presentation_format @presentation_format end |
#scale_crop ⇒ Boolean Also known as: ScaleCrop
Returns The display mode for the document thumbnail.
70 71 72 |
# File 'lib/axlsx/doc_props/app.rb', line 70 def scale_crop @scale_crop end |
#shared_doc ⇒ Boolean Also known as:
Returns Indicates if the document is shared.
82 83 84 |
# File 'lib/axlsx/doc_props/app.rb', line 82 def shared_doc @shared_doc end |
#slides ⇒ Intger Also known as: Slides
Returns The number of slides in the document.
50 51 52 |
# File 'lib/axlsx/doc_props/app.rb', line 50 def @slides end |
#template ⇒ String Also known as: Template
Returns The name of the document template.
14 15 16 |
# File 'lib/axlsx/doc_props/app.rb', line 14 def template @template end |
#total_time ⇒ Integer Also known as: TotalTime
Returns The total amount of time spent editing.
58 59 60 |
# File 'lib/axlsx/doc_props/app.rb', line 58 def total_time @total_time end |
#words ⇒ Integer Also known as: Words
Returns The number of words in the document.
30 31 32 |
# File 'lib/axlsx/doc_props/app.rb', line 30 def words @words end |
Instance Method Details
#to_xml_string(str = '') ⇒ String
Serialize the app.xml document
220 221 222 223 224 225 |
# File 'lib/axlsx/doc_props/app.rb', line 220 def to_xml_string(str = '') str << '<?xml version="1.0" encoding="UTF-8"?>' str << '<Properties xmlns="' << APP_NS << '" xmlns:vt="' << APP_NS_VT << '">' str << instance_values.map { |key, value| '<' << Axlsx.camel(key) << '>' << value.to_s << '</' << Axlsx.camel(key) << '>' }.join str << '</Properties>' end |