Class: AsposeWordsCloud::InsertFieldOnlineRequest

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

Overview

Request model for insert_field_online operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, field, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil) ⇒ InsertFieldOnlineRequest

Initializes a new instance.

Parameters:

  • document —

    The document.

  • field —

    Field data.

  • node_path (defaults to: nil) —

    The path to the node in the document tree.

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

  • revision_author (defaults to: nil) —

    Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  • revision_date_time (defaults to: nil) —

    The date and time to use for revisions.

  • insert_before_node (defaults to: nil) —

    The index of the node. A new field will be inserted before the node with the specified node Id.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/aspose_words_cloud/models/requests/insert_field_online_request.rb', line 71

def initialize(document, field, node_path = nil, load_encoding = nil, password = nil, dest_file_name = nil, revision_author = nil, revision_date_time = nil, insert_before_node = nil)
  self.document = document
  self.field = field
  self.node_path = node_path
  self.load_encoding = load_encoding
  self.password = password
  self.dest_file_name = dest_file_name
  self.revision_author = revision_author
  self.revision_date_time = revision_date_time
  self.insert_before_node = insert_before_node
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.



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

def dest_file_name
  @dest_file_name
end

#document ⇒ Object

The document.



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

def document
  @document
end

#field ⇒ Object

Field data.



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

def field
  @field
end

#insert_before_node ⇒ Object

The index of the node. A new field will be inserted before the node with the specified node Id.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/insert_field_online_request.rb', line 57

def insert_before_node
  @insert_before_node
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/insert_field_online_request.rb', line 42

def load_encoding
  @load_encoding
end

#node_path ⇒ Object

The path to the node in the document tree.



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

def node_path
  @node_path
end

#password ⇒ Object

Password for opening an encrypted document.



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

def password
  @password
end

#revision_author ⇒ Object

Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.



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

def revision_author
  @revision_author
end

#revision_date_time ⇒ Object

The date and time to use for revisions.



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

def revision_date_time
  @revision_date_time
end