Parameters Related Methods
The following methods are available regarding document parameter management.
| CreateParameter(IDocument doc, IParameterDef pd, T value, int? index = null, int? parentId = null, byte[] data = null) | Create a new parameter on a document. | The created document parameter. |
|---|---|---|
| CreateParameter(int docId, int pdId, T value, int? index = null, int? parentId = null, byte[] data = null) | Create a new parameter on a document. | The created document parameter. |
| FindParameter(int docId, int pdId, bool includeVerification = false, int? index = null) | Try to find a parameter by filter criteria. | The document parameter object, if found. |
| FindParameter(IDocument doc, int pdId, bool includeVerification = false, int? index = null) | Try to find a parameter by filter criteria. | The document parameter object, if found. |
| FindParameter(IDocument doc, IParameterDef pd, bool includeVerification = false, int? index = null) | Try to find a parameter by filter criteria. | The document parameter object, if found. |
| GetParameters(IDocument doc, IParameterDef pd, bool includeVerification = false, int? index = null) | Gets all document parameters created on a document. | A list of document parameters. |
| GetParameters(IDocument doc, int pdId, bool includeVerification = false, int? index = null) | Gets all document parameters created on a document. | A list of document parameters. |
| GetParameterChildren(IDocumentParameter par, bool includeParDefs = false, bool includeVerification = false) | Gets all the children document parameters of a document parameter. | A list of document parameters. |
| FindParentIndex(IDocumentParameter par, int parentPdId) | Try to find the index of a parent document parameter. | The index, parameter definition, and parameter object of the document parameter. |
| FindParameterByParentIndex(IDocumentParameter par, int pdId, int parentPdId, bool includeVerification = false) | Try to find the document parameter by index. | The document parameter. |
| FindParameterByParentIndex(IDocumentParameter par, IParameterDef pd, IParameterDef parentPd, bool includeVerification = false) | Try to find the document parameter by index. | The document parameter. |
| FindParameterByParentIndex(IDocumentParameter par, int pdId, int parentPdId, bool includeVerification = false) | Try to find the document parameter by index. | The document parameter. |
| FindParameterByParentIndex(IDocumentParameter par, IParameterDef pd, string parentName, bool includeVerification = false) | Try to find the document parameter by index. | The document parameter. |
| FindParameterByParentIndex(IDocumentParameter par, int pdId, string parentName, bool includeVerification = false) | Try to find the document parameter by index. | The document parameter. |
| GetTable(IDocument doc, string name, int? pageindex = null) | Gets a table document parameter. | The document parameter. |