Class: AsposeWordsCloud::ReplaceWithTextRequest

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

Overview

Request model for replace_with_text operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, range_start_identifier, range_text, range_end_identifier = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil) ⇒ ReplaceWithTextRequest

Initializes a new instance.

Parameters:

  • name —

    The document.

  • range_start_identifier —

    The range start identifier. Identifier is the value of the “nodeId” field, which every document node has, extended with the prefix “id”. It looks like “id0.0.7”. Also values like “image5” and “table3” can be used as an identifier for images and tables, where the number is an index of the image/table.

  • range_text —

    Model with text for replacement.

  • range_end_identifier (defaults to: nil) —

    The range end identifier.

  • 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.

  • dest_file_name (defaults to: nil) —

    Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 73

def initialize(name, range_start_identifier, range_text, range_end_identifier = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, dest_file_name = nil)
  self.name = name
  self.range_start_identifier = range_start_identifier
  self.range_text = range_text
  self.range_end_identifier = range_end_identifier
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.dest_file_name = dest_file_name
end

Instance Attribute Details

#dest_file_name ⇒ Object

Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document.



59
60
61
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 59

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



47
48
49
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 47

def folder
  @folder
end

#load_encoding ⇒ Object

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



53
54
55
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 53

def load_encoding
  @load_encoding
end

#name ⇒ Object

The document.



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

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



56
57
58
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 56

def password
  @password
end

#range_end_identifier ⇒ Object

The range end identifier.



44
45
46
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 44

def range_end_identifier
  @range_end_identifier
end

#range_start_identifier ⇒ Object

The range start identifier. Identifier is the value of the “nodeId” field, which every document node has, extended with the prefix “id”. It looks like “id0.0.7”. Also values like “image5” and “table3” can be used as an identifier for images and tables, where the number is an index of the image/table.



38
39
40
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 38

def range_start_identifier
  @range_start_identifier
end

#range_text ⇒ Object

Model with text for replacement.



41
42
43
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 41

def range_text
  @range_text
end

#storage ⇒ Object

Original document storage.



50
51
52
 
# File 'lib/aspose_words_cloud/models/requests/replace_with_text_request.rb', line 50

def storage
  @storage
end