Class: AsposeWordsCloud::GetDocumentStatisticsOnlineRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb

Overview

Request model for get_document_statistics_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil) ⇒ GetDocumentStatisticsOnlineRequest

Initializes a new instance.

Parameters:

  • document —

    The document.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • include_comments (defaults to: nil) —

    The flag indicating whether to include comments from the WordCount. The default value is “false”.

  • include_footnotes (defaults to: nil) —

    The flag indicating whether to include footnotes from the WordCount. The default value is “false”.

  • include_text_in_shapes (defaults to: nil) —

    The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.



59
60
61
62
63
64
65
66
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 59

def initialize(document, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil)
  self.document = document
  self.load_encoding = load_encoding
  self.password = password
  self.include_comments = include_comments
  self.include_footnotes = include_footnotes
  self.include_text_in_shapes = include_text_in_shapes
end

Instance Attribute Details

#document ⇒ Object

The document.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 33

def document
  @document
end

#include_comments ⇒ Object

The flag indicating whether to include comments from the WordCount. The default value is “false”.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 42

def include_comments
  @include_comments
end

#include_footnotes ⇒ Object

The flag indicating whether to include footnotes from the WordCount. The default value is “false”.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 45

def include_footnotes
  @include_footnotes
end

#include_text_in_shapes ⇒ Object

The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 48

def include_text_in_shapes
  @include_text_in_shapes
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 36

def load_encoding
  @load_encoding
end

#password ⇒ Object

Password for opening an encrypted document.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_online_request.rb', line 39

def password
  @password
end