MathObject
OfficeMathObject
Represents a dTO container with an OfficeMath object.
This class is inherited from OfficeMathLink and used in OfficeMathObjectResponse, OfficeMathObjectsCollection.
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. |
Content | StoryChildNodes | Gets or sets the content of a footnote. |
DisplayType | DisplayTypeEnum | Gets or sets the display format type of the OfficeMath object. This display format defines whether an equation is displayed inline with the text or displayed on its own line. |
Justification | JustificationEnum | Gets or sets the justification of the OfficeMath object. |
MathObjectType | MathObjectTypeEnum | Gets or sets the type of the OfficeMath object. |
OfficeMathObjectsCollection
Represents a dTO container with a collection of OfficeMath objects.
This class is inherited from LinkElement and used in OfficeMathObjectsResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
List | List<OfficeMathObject> | Gets or sets the collection of OfficeMath objects. |
OfficeMathObjectResponse
Represents a REST response with a OfficeMath object.
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. |
OfficeMathObject | OfficeMathObject | Gets or sets the OfficeMath object. |
OfficeMathObjectsResponse
Represents a REST response with a collection of OfficeMath objects.
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. |
OfficeMathObjects | OfficeMathObjectsCollection | Gets or sets the collection of OfficeMath objects. |
DeleteOfficeMathObjectOnlineRequest
Represents a request model for WordsApi.DeleteOfficeMathObjectOnline() operation.
An object of the DeleteOfficeMathObjectOnlineRequest class is created by the following constructor methods:
- DeleteOfficeMathObjectOnlineRequest()
- DeleteOfficeMathObjectOnlineRequest(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. |
DeleteOfficeMathObjectRequest
Represents a request model for WordsApi.DeleteOfficeMathObject() operation.
An object of the DeleteOfficeMathObjectRequest class is created by the following constructor methods:
- DeleteOfficeMathObjectRequest()
- DeleteOfficeMathObjectRequest(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. |
GetOfficeMathObjectOnlineRequest
Represents a request model for WordsApi.GetOfficeMathObjectOnline() operation.
An object of the GetOfficeMathObjectOnlineRequest class is created by the following constructor methods:
- GetOfficeMathObjectOnlineRequest()
- GetOfficeMathObjectOnlineRequest(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. |
GetOfficeMathObjectRequest
Represents a request model for WordsApi.GetOfficeMathObject() operation.
An object of the GetOfficeMathObjectRequest class is created by the following constructor methods:
- GetOfficeMathObjectRequest()
- GetOfficeMathObjectRequest(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. |
GetOfficeMathObjectsOnlineRequest
Represents a request model for WordsApi.GetOfficeMathObjectsOnline() operation.
An object of the GetOfficeMathObjectsOnlineRequest class is created by the following constructor methods:
- GetOfficeMathObjectsOnlineRequest()
- GetOfficeMathObjectsOnlineRequest(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. |
GetOfficeMathObjectsRequest
Represents a request model for WordsApi.GetOfficeMathObjects() operation.
An object of the GetOfficeMathObjectsRequest class is created by the following constructor methods:
- GetOfficeMathObjectsRequest()
- GetOfficeMathObjectsRequest(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. |
RenderMathObjectOnlineRequest
Represents a request model for WordsApi.RenderMathObjectOnline() operation.
An object of the RenderMathObjectOnlineRequest class is created by the following constructor methods:
- RenderMathObjectOnlineRequest()
- RenderMathObjectOnlineRequest(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. |
RenderMathObjectRequest
Represents a request model for WordsApi.RenderMathObject() operation.
An object of the RenderMathObjectRequest class is created by the following constructor methods:
- RenderMathObjectRequest()
- RenderMathObjectRequest(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. |
OfficeMathObject.DisplayTypeEnum
The following values are defined: Display, Inline.
OfficeMathObject.JustificationEnum
The following values are defined: CenterGroup, Default, Center, Left, Right, Inline.
OfficeMathObject.MathObjectTypeEnum
The following values are defined: OMath, OMathPara, Accent, Bar, BorderBox, Box, Delimiter, Degree, Argument, Array, Fraction, Denominator, Numerator, Function, FunctionName, GroupCharacter, Limit, LowerLimit, UpperLimit, Matrix, MatrixRow, NAry, Phantom, Radical, SubscriptPart, SuperscriptPart, PreSubSuperscript, Subscript, SubSuperscript, Supercript.