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
@return [String] The version of the application.
@return [String] The name of the application
@return [Integer] The number of characters in the document.
@return [Integer] The number of characters in the document including spaces.
@return [String] The name of the company generating the document.
@return [Integer] Document security
@return [Integer] The number of hidden slides.
@return [String] The base for hyper links in the document.
@return [Boolean] Indicates that the hyper links in the document have been changed.
@return [Integer] The number of lines in the document.
@return [Boolean] The links in the document are up to date.
@return [Integer] The total number multimedia clips
@return [String] The name of the manager for the document.
@return [Integer] The number of slides that have notes.
@return [Integer] The number of pages in the document.
@return [Integer] The number of paragraphs in the document
@return [String] The intended format of the presentation.
@return [Boolean] The display mode for the document thumbnail.
@return [Intger] The number of slides in the document.
@return [String] The name of the document template.
@return [Integer] The total amount of time spent editing.
@return [Integer] The number of words in the document.
@return [String] The version of the application.
@return [String] The name of the application
@return [Integer] The number of characters in the document.
@return [Integer] The number of characters in the document including spaces.
@return [String] The name of the company generating the document.
@return [Integer] Document security
@return [String] The base for hyper links in the document.
@return [Boolean] Indicates that the hyper links in the document have been changed.
@return [Integer] The number of lines in the document.
@return [Boolean] The links in the document are up to date.
@return [Integer] The total number multimedia clips
@return [String] The name of the manager for the document.
@return [Integer] The number of slides that have notes.
@return [Integer] The number of pages in the document.
@return [Integer] The number of paragraphs in the document
@return [String] The intended format of the presentation.
@return [Boolean] The display mode for the document thumbnail.
@return [Intger] The number of slides in the document.
@return [String] The name of the document template.
@return [Integer] The total amount of time spent editing.
@return [Integer] The number of words in the document.
Public Class Methods
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
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
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
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
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
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
Sets the hyperlink_base
property of your app.xml file
# File lib/axlsx/doc_props/app.rb, line 206 def hyperlink_base=(v) Axlsx::validate_string v; @hyperlink_base = v; end
Sets the HyperLinksChanged property of your app.xml file
# File lib/axlsx/doc_props/app.rb, line 210 def hyperlinks_changed=(v) Axlsx::validate_boolean v; @hyperlinks_changed = v; end
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
Sets the links_up_to_date
property of your app.xml file
# File lib/axlsx/doc_props/app.rb, line 194 def links_up_to_date=(v) Axlsx::validate_boolean v; @links_up_to_date = v; end
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
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
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
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
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
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
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
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
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
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
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
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