class Axlsx::App

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 shared-documentPropertiesExtended.xsd @note Support is not implemented for the following complex types:

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

Attributes

AppVersion[R]

@return [String] The version of the application.

Applicatoin[R]

@return [String] The name of the application

Characters[R]

@return [Integer] The number of characters in the document.

CharactersWithSpaces[R]

@return [Integer] The number of characters in the document including spaces.

Company[R]

@return [String] The name of the company generating the document.

DocSecurity[R]

@return [Integer] Document security

HiddenSlides[R]

@return [Integer] The number of hidden slides.

HyperlinkBase[R]

@return [String] The base for hyper links in the document.

HyperlinksChanged[R]

@return [Boolean] Indicates that the hyper links in the document have been changed.

Lines[R]

@return [Integer] The number of lines in the document.

LinksUpToDate[R]

@return [Boolean] The links in the document are up to date.

MMClips[R]

@return [Integer] The total number multimedia clips

Manager[R]

@return [String] The name of the manager for the document.

Notes[R]

@return [Integer] The number of slides that have notes.

Pages[R]

@return [Integer] The number of pages in the document.

Paragraphs[R]

@return [Integer] The number of paragraphs in the document

PresentationFormat[R]

@return [String] The intended format of the presentation.

ScaleCrop[R]

@return [Boolean] The display mode for the document thumbnail.

SharedDoc[R]

@return [Boolean] Indicates if the document is shared.

Slides[R]

@return [Intger] The number of slides in the document.

Template[R]

@return [String] The name of the document template.

TotalTime[R]

@return [Integer] The total amount of time spent editing.

Words[R]

@return [Integer] The number of words in the document.

app_version[R]

@return [String] The version of the application.

application[R]

@return [String] The name of the application

characters[R]

@return [Integer] The number of characters in the document.

characters_with_spaces[R]

@return [Integer] The number of characters in the document including spaces.

company[R]

@return [String] The name of the company generating the document.

doc_security[R]

@return [Integer] Document security

hidden_slides[R]

@return [Integer] The number of hidden slides.

lines[R]

@return [Integer] The number of lines in the document.

m_m_clips[R]

@return [Integer] The total number multimedia clips

manager[R]

@return [String] The name of the manager for the document.

notes[R]

@return [Integer] The number of slides that have notes.

pages[R]

@return [Integer] The number of pages in the document.

paragraphs[R]

@return [Integer] The number of paragraphs in the document

presentation_format[R]

@return [String] The intended format of the presentation.

scale_crop[R]

@return [Boolean] The display mode for the document thumbnail.

shared_doc[R]

@return [Boolean] Indicates if the document is shared.

slides[R]

@return [Intger] The number of slides in the document.

template[R]

@return [String] The name of the document template.

total_time[R]

@return [Integer] The total amount of time spent editing.

words[R]

@return [Integer] The number of words in the document.

Public Class Methods

new(options={}) click to toggle source

Creates an App object @option options [String] template @option options [String] manager @option options [Integer] pages @option options [Integer] words @option options [Integer] characters @option options [String] presentation_format @option options [Integer] lines @option options [Integer] paragraphs @option options [Integer] slides @option options [Integer] notes @option options [Integer] total_time @option options [Integer] hidden_slides @option options [Integer] m_m_clips @option options [Boolean] scale_crop @option options [Boolean] links_up_to_date @option options [Integer] characters_with_spaces @option options [Boolean] share_doc @option options [String] hyperlink_base @option options [String] hyperlinks_changed @option options [String] application @option options [String] app_version @option options [Integer] doc_security

# File lib/axlsx/doc_props/app.rb, line 39
def initialize(options={})
  parse_options options
end

Public Instance Methods

AppVersion=(v)
Alias for: app_version=
Characters=(v)
Alias for: characters=
CharactersWithSpaces=(v)
Company=(v)
Alias for: company=
DocSecurity=(v)
Alias for: doc_security=
HiddenSlides=(v)
Alias for: hidden_slides=
HyperLinksChanged=(v)
Alias for: hyperlinks_changed=
HyperlinkBase=(v)
Alias for: hyperlink_base=
Lines=(v)
Alias for: lines=
LinksUpToDate=(v)
Alias for: links_up_to_date=
MMClips=(v)
Alias for: m_m_clips=
Manager=(v)
Alias for: manager=
Notes=(v)
Alias for: notes=
Paragraphs=(v)
Alias for: paragraphs=
PresentationFormat=(v)
ScaleCrop=(v)
Alias for: scale_crop=
SharedDoc=(v)
Alias for: shared_doc=
Slides=(v)
Alias for: slides=
Template=(v)
Alias for: template=
TotalTime=(v)
Alias for: total_time=
Words=(v)
Alias for: words=
app_version=(v) click to toggle source

Sets the app_version property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 214
def app_version=(v) Axlsx::validate_string v; @app_version = v; end
Also aliased as: AppVersion=
characters=(v) click to toggle source

Sets the characters property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 154
def characters=(v) Axlsx::validate_int v; @characters = v; end
Also aliased as: Characters=
characters_with_spaces=(v) click to toggle source

Sets the characters_with_spaces property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 198
def characters_with_spaces=(v) Axlsx::validate_int v; @characters_with_spaces = v; end
Also aliased as: CharactersWithSpaces=
company=(v) click to toggle source

Sets the company property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 144
def company=(v) Axlsx::validate_string v; @company = v; end
Also aliased as: Company=
doc_security=(v) click to toggle source

Sets the doc_security property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 218
def doc_security=(v) Axlsx::validate_int v; @doc_security = v; end
Also aliased as: DocSecurity=
hidden_slides=(v) click to toggle source

Sets the hidden_slides property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 182
def hidden_slides=(v) Axlsx::validate_int v; @hidden_slides = v; end
Also aliased as: HiddenSlides=
lines=(v) click to toggle source

Sets the lines property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 162
def lines=(v) Axlsx::validate_int v; @lines = v; end
Also aliased as: Lines=
m_m_clips=(v) click to toggle source

Sets the m_m_clips property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 186
def m_m_clips=(v) Axlsx::validate_int v; @m_m_clips = v; end
Also aliased as: MMClips=
manager=(v) click to toggle source

Sets the manager property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 140
def manager=(v) Axlsx::validate_string v; @manager = v; end
Also aliased as: Manager=
notes=(v) click to toggle source

sets the notes property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 174
def notes=(v) Axlsx::validate_int v; @notes = v; end
Also aliased as: Notes=
pages=(v) click to toggle source

Sets the pages property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 147
def pages=(v) Axlsx::validate_int v; @pages = v; end
paragraphs=(v) click to toggle source

Sets the paragraphs property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 166
def paragraphs=(v) Axlsx::validate_int v; @paragraphs = v; end
Also aliased as: Paragraphs=
presentation_format=(v) click to toggle source

Sets the presentation_format property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 158
def presentation_format=(v) Axlsx::validate_string v; @presentation_format = v; end
Also aliased as: PresentationFormat=
scale_crop=(v) click to toggle source

Sets the scale_crop property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 190
def scale_crop=(v) Axlsx::validate_boolean v; @scale_crop = v; end
Also aliased as: ScaleCrop=
shared_doc=(v) click to toggle source

Sets the share_doc property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 202
def shared_doc=(v) Axlsx::validate_boolean v; @shared_doc = v; end
Also aliased as: SharedDoc=
slides=(v) click to toggle source

sets the slides property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 170
def slides=(v) Axlsx::validate_int v; @slides = v; end
Also aliased as: Slides=
template=(v) click to toggle source

Sets the template property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 136
def template=(v) Axlsx::validate_string v; @template = v; end
Also aliased as: Template=
to_xml_string(str = '') click to toggle source

Serialize the app.xml document @return [String]

# 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
total_time=(v) click to toggle source

Sets the total_time property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 178
def total_time=(v) Axlsx::validate_int v; @total_time = v; end
Also aliased as: TotalTime=
words=(v) click to toggle source

Sets the words property of your app.xml file

# File lib/axlsx/doc_props/app.rb, line 150
def words=(v) Axlsx::validate_int v; @words = v; end
Also aliased as: Words=