DrawingObject
DrawingObject
Represents a dTO container with a DrawingObject.
This class is inherited from DrawingObjectLink and used in DrawingObjectResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
NodeId | string | Gets or sets the node id. |
Height | double | Gets or sets the height of the DrawingObject in points. |
ImageDataLink | WordsApiLink | Gets or sets the link to image data. Can be null if shape does not have an image. |
Left | double | Gets or sets the distance in points from the origin to the left side of the image. |
OleDataLink | WordsApiLink | Gets or sets the link to OLE object. Can be null if shape does not have OLE data. |
RelativeHorizontalPosition | RelativeHorizontalPositionEnum | Gets or sets the relative horizontal position, from which the distance to the image is measured. |
RelativeVerticalPosition | RelativeVerticalPositionEnum | Gets or sets the relative vertical position, from which the distance to the image is measured. |
RenderLinks | List<WordsApiLink> | Gets or sets the list of links that originate from this DrawingObjectDto. |
Top | double | Gets or sets the distance in points from the origin to the top side of the image. |
Width | double | Gets or sets the width of the DrawingObjects in points. |
WrapType | WrapTypeEnum | Gets or sets the option that controls how to wrap text around the image. |
DrawingObjectCollection
Represents a dTO container with a collection of DrawingObjects links.
This class is inherited from LinkElement and used in DrawingObjectsResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
List | List<LinkElement> | Gets or sets the collection of DrawingObjects links. |
DrawingObjectInsert
Represents a drawing object element for insert.
This class is used in InsertDrawingObjectOnlineRequest, InsertDrawingObjectRequest.
The following properties are defined:
Property | Type | Description |
---|---|---|
Height | double | Gets or sets the height of the DrawingObject in points. |
Left | double | Gets or sets the distance in points from the origin to the left side of the image. |
Position | DocumentPosition | Gets or sets the position, before which the DrawingObject will be inserted. |
RelativeHorizontalPosition | RelativeHorizontalPositionEnum | Gets or sets the relative horizontal position, from which the distance to the image is measured. |
RelativeVerticalPosition | RelativeVerticalPositionEnum | Gets or sets the relative vertical position, from which the distance to the image is measured. |
Top | double | Gets or sets the distance in points from the origin to the top side of the image. |
Width | double | Gets or sets the width of the DrawingObjects in points. |
WrapType | WrapTypeEnum | Gets or sets the option indicating how to wrap text around the image. |
DrawingObjectLink
Represents a link for Drawing Object DTO.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
NodeId | string | Gets or sets the node id. |
DrawingObjectUpdate
Represents a drawing object element for update.
This class is used in UpdateDrawingObjectOnlineRequest, UpdateDrawingObjectRequest.
The following properties are defined:
Property | Type | Description |
---|---|---|
Height | double | Gets or sets the height of the DrawingObject in points. |
Left | double | Gets or sets the distance in points from the origin to the left side of the image. |
RelativeHorizontalPosition | RelativeHorizontalPositionEnum | Gets or sets the relative horizontal position, from which the distance to the image is measured. |
RelativeVerticalPosition | RelativeVerticalPositionEnum | Gets or sets the relative vertical position, from which the distance to the image measured. |
Top | double | Gets or sets the distance in points from the origin to the top side of the image. |
Width | double | Gets or sets the width of the DrawingObjects in points. |
WrapType | WrapTypeEnum | Gets or sets the option that controls how to wrap text around the image. |
DrawingObjectsResponse
Represents a REST response with a collection of DrawingObjects.
This class is inherited from WordsResponse and used in WordsApi.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
DrawingObjects | DrawingObjectCollection | Gets or sets the collection of DrawingObjects. |
DeleteDrawingObjectOnlineRequest
Represents a request model for WordsApi.DeleteDrawingObjectOnline() operation.
An object of the DeleteDrawingObjectOnlineRequest class is created by the following constructor methods:
- DeleteDrawingObjectOnlineRequest()
- DeleteDrawingObjectOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
DeleteDrawingObjectRequest
Represents a request model for WordsApi.DeleteDrawingObject() operation.
An object of the DeleteDrawingObjectRequest class is created by the following constructor methods:
- DeleteDrawingObjectRequest()
- DeleteDrawingObjectRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
DrawingObjectResponse
Represents a REST response with a DrawingObject.
This class is inherited from WordsResponse and used in WordsApi, InsertDrawingObjectOnlineResponse, UpdateDrawingObjectOnlineResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
DrawingObject | DrawingObject | Gets or sets the DrawingObject. |
GetDocumentDrawingObjectByIndexOnlineRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectByIndexOnline() operation.
An object of the GetDocumentDrawingObjectByIndexOnlineRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectByIndexOnlineRequest()
- GetDocumentDrawingObjectByIndexOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectByIndexRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectByIndex() operation.
An object of the GetDocumentDrawingObjectByIndexRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectByIndexRequest()
- GetDocumentDrawingObjectByIndexRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectImageDataOnlineRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectImageDataOnline() operation.
An object of the GetDocumentDrawingObjectImageDataOnlineRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectImageDataOnlineRequest()
- GetDocumentDrawingObjectImageDataOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectImageDataRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectImageData() operation.
An object of the GetDocumentDrawingObjectImageDataRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectImageDataRequest()
- GetDocumentDrawingObjectImageDataRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectOleDataOnlineRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectOleDataOnline() operation.
An object of the GetDocumentDrawingObjectOleDataOnlineRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectOleDataOnlineRequest()
- GetDocumentDrawingObjectOleDataOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectOleDataRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectOleData() operation.
An object of the GetDocumentDrawingObjectOleDataRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectOleDataRequest()
- GetDocumentDrawingObjectOleDataRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectsOnlineRequest
Represents a request model for WordsApi.GetDocumentDrawingObjectsOnline() operation.
An object of the GetDocumentDrawingObjectsOnlineRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectsOnlineRequest()
- GetDocumentDrawingObjectsOnlineRequest(Stream document, string nodePath, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentDrawingObjectsRequest
Represents a request model for WordsApi.GetDocumentDrawingObjects() operation.
An object of the GetDocumentDrawingObjectsRequest class is created by the following constructor methods:
- GetDocumentDrawingObjectsRequest()
- GetDocumentDrawingObjectsRequest(string name, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
InsertDrawingObjectOnlineRequest
Represents a request model for WordsApi.InsertDrawingObjectOnline() operation.
An object of the InsertDrawingObjectOnlineRequest class is created by the following constructor methods:
- InsertDrawingObjectOnlineRequest()
- InsertDrawingObjectOnlineRequest(Stream document, DrawingObjectInsert drawingObject, Stream imageFile, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
drawingObject | DrawingObject | DrawingObjectInsert | Drawing object parameters. |
imageFile | ImageFile | Stream | File with image. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
InsertDrawingObjectOnlineResponse
Represents a response model for WordsApi.InsertDrawingObjectOnline() operation.
An object of the InsertDrawingObjectOnlineResponse class is created by the following constructor methods:
- InsertDrawingObjectOnlineResponse(DrawingObjectResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | DrawingObjectResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
InsertDrawingObjectRequest
Represents a request model for WordsApi.InsertDrawingObject() operation.
An object of the InsertDrawingObjectRequest class is created by the following constructor methods:
- InsertDrawingObjectRequest()
- InsertDrawingObjectRequest(string name, DrawingObjectInsert drawingObject, Stream imageFile, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
drawingObject | DrawingObject | DrawingObjectInsert | Drawing object parameters. |
imageFile | ImageFile | Stream | File with image. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
RenderDrawingObjectOnlineRequest
Represents a request model for WordsApi.RenderDrawingObjectOnline() operation.
An object of the RenderDrawingObjectOnlineRequest class is created by the following constructor methods:
- RenderDrawingObjectOnlineRequest()
- RenderDrawingObjectOnlineRequest(Stream document, string format, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
format | Format | string | The destination format. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
RenderDrawingObjectRequest
Represents a request model for WordsApi.RenderDrawingObject() operation.
An object of the RenderDrawingObjectRequest class is created by the following constructor methods:
- RenderDrawingObjectRequest()
- RenderDrawingObjectRequest(string name, string format, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
format | Format | string | The destination format. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
UpdateDrawingObjectOnlineRequest
Represents a request model for WordsApi.UpdateDrawingObjectOnline() operation.
An object of the UpdateDrawingObjectOnlineRequest class is created by the following constructor methods:
- UpdateDrawingObjectOnlineRequest()
- UpdateDrawingObjectOnlineRequest(Stream document, DrawingObjectUpdate drawingObject, Stream imageFile, int index, string nodePath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
drawingObject | DrawingObject | DrawingObjectUpdate | Drawing object parameters. |
imageFile | ImageFile | Stream | File with image. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
UpdateDrawingObjectOnlineResponse
Represents a response model for WordsApi.UpdateDrawingObjectOnline() operation.
An object of the UpdateDrawingObjectOnlineResponse class is created by the following constructor methods:
- UpdateDrawingObjectOnlineResponse(DrawingObjectResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | DrawingObjectResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
UpdateDrawingObjectRequest
Represents a request model for WordsApi.UpdateDrawingObject() operation.
An object of the UpdateDrawingObjectRequest class is created by the following constructor methods:
- UpdateDrawingObjectRequest()
- UpdateDrawingObjectRequest(string name, DrawingObjectUpdate drawingObject, Stream imageFile, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
drawingObject | DrawingObject | DrawingObjectUpdate | Drawing object parameters. |
imageFile | ImageFile | Stream | File with image. |
index | Index | int | Object index. |
nodePath | NodePath | string | The path to the node in the document tree. |
folder | Folder | string | Original document folder. |
storage | Storage | string | Original document storage. |
loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
destFileName | DestFileName | string | 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. |
revisionAuthor | RevisionAuthor | string | 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. |
revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
DrawingObject.RelativeHorizontalPositionEnum
The following values are defined: Margin, Page, Column, Default, Character, LeftMargin, RightMargin, InsideMargin, OutsideMargin.
DrawingObject.RelativeVerticalPositionEnum
The following values are defined: Margin, TableDefault, Page, Paragraph, TextFrameDefault, Line, TopMargin, BottomMargin, InsideMargin, OutsideMargin.
DrawingObject.WrapTypeEnum
The following values are defined: Inline, TopBottom, Square, None, Tight, Through.
DrawingObjectInsert.RelativeHorizontalPositionEnum
The following values are defined: Margin, Page, Column, Default, Character, LeftMargin, RightMargin, InsideMargin, OutsideMargin.
DrawingObjectInsert.RelativeVerticalPositionEnum
The following values are defined: Margin, TableDefault, Page, Paragraph, TextFrameDefault, Line, TopMargin, BottomMargin, InsideMargin, OutsideMargin.
DrawingObjectInsert.WrapTypeEnum
The following values are defined: Inline, TopBottom, Square, None, Tight, Through.
DrawingObjectUpdate.RelativeHorizontalPositionEnum
The following values are defined: Margin, Page, Column, Default, Character, LeftMargin, RightMargin, InsideMargin, OutsideMargin.
DrawingObjectUpdate.RelativeVerticalPositionEnum
The following values are defined: Margin, TableDefault, Page, Paragraph, TextFrameDefault, Line, TopMargin, BottomMargin, InsideMargin, OutsideMargin.
DrawingObjectUpdate.WrapTypeEnum
The following values are defined: Inline, TopBottom, Square, None, Tight, Through.