Class WMDocument
Class providing directory type behavior to IWMAsset
Implements
Inherited Members
Namespace: Quantellia.WMServer.Asset.Document
Assembly: WMServer.dll
Syntax
[HasDTO(typeof(WMDocumentDTO))]
public class WMDocument : WMAssetBase, IWMAsset, IDbEntity, IWMEntity, IDocumentedEntity, INamedEntity, IWMAssetDirectoryMember, IWMPrincipalOwnedConstructors
WMDocument()
Parameterless Constructor. Will populate a random GUID as ID
Declaration
public WMDocument()WMDocument(string)
Constructor that specifies ID
Declaration
public WMDocument(string ID)Parameters
| Type | Name | Description |
|---|---|---|
| string | ID |
Properties
DocumentData
A Base-64 encoded string representing the stored document
Declaration
public string DocumentData { get; set; }Property Value
| Type | Description |
|---|---|
| string |
DocumentEditedText
Stores the text of a document in an editable format. Is not guaranteed to be correct, or exist.
Declaration
public string DocumentEditedText { get; set; }Property Value
| Type | Description |
|---|---|
| string |
DocumentMIMEType
The type of the stored data.
Declaration
public string DocumentMIMEType { get; set; }Property Value
| Type | Description |
|---|---|
| string |
DocumentName
The name of the source document that was imported or created.
Declaration
public string DocumentName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
GenerateFromTemplate(WMPrincipal, string, ADGArgs, WMAppDbContext)
Generates a new document given an existing template, and the evaluation results from a model in the decision model engine.
Declaration
public static Task<ADGReturnArgs> GenerateFromTemplate(WMPrincipal principal, string id, ADGArgs args, WMAppDbContext context)Parameters
| Type | Name | Description |
|---|---|---|
| WMPrincipal | principal | |
| string | id | The id of the template document |
| ADGArgs | args | Args dictating the ADG |
| WMAppDbContext | context |
Returns
| Type | Description |
|---|---|
| Task<ADGReturnArgs> |
GetText()
Convert the contained document to text, and return as a string.
Declaration
public string GetText()Returns
| Type | Description |
|---|---|
| string |