Class: AsposeWordsCloud::GetDocumentStatisticsRequest

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

Overview

Request model for get_document_statistics operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil) ⇒ GetDocumentStatisticsRequest

Initializes a new instance.

Parameters:

  • name —

    The document name.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • 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) —

    Support including/excluding comments from the WordCount. Default value is “false”.

  • include_footnotes (defaults to: nil) —

    Support including/excluding footnotes from the WordCount. Default value is “false”.

  • include_text_in_shapes (defaults to: nil) —

    Support including/excluding shape’s text from the WordCount. Default value is “false”.



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 67

def initialize(name, folder = nil, storage = nil, load_encoding = nil, password = nil, include_comments = nil, include_footnotes = nil, include_text_in_shapes = nil)
  self.name = name
  self.folder = folder
  self.storage = storage
  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

#folder ⇒ Object

Original document folder.



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

def folder
  @folder
end

#include_comments ⇒ Object

Support including/excluding comments from the WordCount. Default value is “false”.



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

def include_comments
  @include_comments
end

#include_footnotes ⇒ Object

Support including/excluding footnotes from the WordCount. Default value is “false”.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 51

def include_footnotes
  @include_footnotes
end

#include_text_in_shapes ⇒ Object

Support including/excluding shape’s text from the WordCount. Default value is “false”.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/get_document_statistics_request.rb', line 54

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.



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

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document name.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#storage ⇒ Object

Original document storage.



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

def storage
  @storage
end