A newer version of this page is available. Switch to the current version.

TreeListExtension Methods

An extension object implementing the TreeList functionality.
Name Description
Bind(Object) Binds the Tree List to a data source.
BindToSiteMap(String) Binds the TreeList to a SiteMap data source.
BindToSiteMap(String, Boolean) Binds the TreeList to a SiteMap data source.
BindToVirtualData(TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) Allows creation of treelist nodes on demand (virtual mode).
BindToXML(String) Binds the TreeList to the XML file specified by its name.
BindToXML(String, String) Binds the TreeList to the XML file specified by its name and an XPath expression.
BindToXML(String, String, String) Binds the TreeList to the XML file specified by its name, XPath expression and transformation file name.
CreatePrintableObject(TreeListSettings) static Enables a TreeList to be printed using the XtraPrinting Library.
CreatePrintableObject(TreeListSettings, Object) static Enables a TreeList to be printed using the XtraPrinting Library.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ExportToDocx(TreeListSettings) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) static Exports the TreeList, which operates in virtual mode, to DOCX, based on the provided settings.
ExportToDocx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, DocxExportOptions) static Exports the TreeList, which operates in virtual mode, to DOCX, based on the provided settings.
ExportToDocx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, DocxExportOptions) static Exports the TreeList, which operates in virtual mode, to DOCX, based on the provided settings.
ExportToDocx(TreeListSettings, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Boolean) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Boolean, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, Boolean) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, Boolean, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, String) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, String, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, String, Boolean) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, Object, String, Boolean, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, String) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, String, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, String, Boolean) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToDocx(TreeListSettings, String, Boolean, DocxExportOptions) static Exports the TreeList's data to DOCX format, based on the provided settings.
ExportToPdf(TreeListSettings) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) static Exports the TreeList, which operates in virtual mode, to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, PdfExportOptions) static Exports the TreeList, which operates in virtual mode, to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, PdfExportOptions) static Exports the TreeList, which operates in virtual mode, to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Boolean) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Boolean, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, Boolean) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, Boolean, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, String) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, String, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, String, Boolean) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, Object, String, Boolean, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, String) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, String, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, String, Boolean) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToPdf(TreeListSettings, String, Boolean, PdfExportOptions) static Exports the TreeList's data to PDF, based on the provided settings.
ExportToRtf(TreeListSettings) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) static Exports the TreeList, which operates in virtual mode, to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, RtfExportOptions) static Exports the TreeList, which operates in virtual mode, to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, RtfExportOptions) static Exports the TreeList, which operates in virtual mode, to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Boolean) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Boolean, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, Boolean) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, Boolean, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, String) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, String, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, String, Boolean) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, Object, String, Boolean, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, String) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, String, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, String, Boolean) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToRtf(TreeListSettings, String, Boolean, RtfExportOptions) static Exports the TreeList's data to RTF, based on the provided settings.
ExportToXls(TreeListSettings) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) static Exports the TreeList, which operates in virtual mode, to XLS, based on the provided settings.
ExportToXls(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, XlsExportOptions) static Exports the TreeList, which operates in virtual mode, to XLS, based on the provided settings.
ExportToXls(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, XlsExportOptions) static Exports the TreeList, which operates in virtual mode, to XLS, based on the provided settings.
ExportToXls(TreeListSettings, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Boolean) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Boolean, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, Boolean) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, Boolean, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, String) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, String, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, String, Boolean) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, Object, String, Boolean, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, String) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, String, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, String, Boolean) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXls(TreeListSettings, String, Boolean, XlsExportOptions) static Exports the TreeList's data to XLS, based on the provided settings.
ExportToXlsx(TreeListSettings) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod) static Exports the TreeList, which operates in virtual mode, to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, XlsxExportOptions) static Exports the TreeList, which operates in virtual mode, to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, XlsxExportOptions) static Exports the TreeList, which operates in virtual mode, to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Boolean) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Boolean, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, Boolean) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, Boolean, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, String) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, String, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, String, Boolean) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, Object, String, Boolean, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, String) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, String, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, String, Boolean) static Exports the TreeList's data to XLSX, based on the provided settings.
ExportToXlsx(TreeListSettings, String, Boolean, XlsxExportOptions) static Exports the TreeList's data to XLSX, based on the provided settings.
GetBatchDeleteKeys<T>() static Returns a list of keys that correspond to tree list records deleted on the client side in batch edit mode.
GetBatchInsertValues<T>(String) static Returns a list of values added to the specified column on the client side in batch edit mode.
GetBatchUpdateValues<S, T>(String) static Returns a dictionary containing record keys and new values updated in the specified column on the client side in batch edit mode.
GetBinaryImageEditCallbackResult() static Returns the specified result back to the client side after processing a callback initiated by a binary image editor used as a TreeList column editor.
GetBinaryImageEditCallbackResult(BinaryStorageMode) static Returns the specified result back to the client side after processing a callback initiated by a binary image editor used as a TreeList column editor.
GetBinaryImageEditCallbackResult(BinaryStorageMode, BinaryImageUploadValidationSettings) static Returns the specified result back to the client side after processing a callback initiated by a binary image editor used as a TreeList column editor.
GetComboBoxCallbackResult(MVCxColumnComboBoxProperties) static Returns the specified result back to the client side after processing a callback initiated by a combo box used as a TreeList column editor.
GetComboBoxCallbackResult(Action<MVCxColumnComboBoxProperties>) static Returns the specified result back to the client side after processing a callback initiated by a combo box used as a TreeList column editor.
GetCustomDataCallbackResult(Object) static Returns the specified result back to the client side after processing a callback within an Action defined TreeListSettings.CustomDataActionRouteValues property. Passes a value that contains specific information (if any) to the client side for further processing.
GetEditValue<T>(String) static Gets editor values from the edit form by a field name.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHtml() Inserts the HTML code rendered by an extension into the required page output. Inherited from ExtensionBase.
GetTokenBoxCallbackResult(MVCxColumnTokenBoxProperties) static Returns the specified result back to the client side after processing a callback initiated by a token box used as a TreeList column editor.
GetTokenBoxCallbackResult(Action<MVCxColumnTokenBoxProperties>) static Returns the specified result back to the client side after processing a callback initiated by a token box used as a TreeList column editor.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Renders the extension's HTML code to the Response. Inherited from ExtensionBase.
SetEditErrorText(String) Displays the specified (error) text in an Error Node at the bottom of the treelist's Edit Form.
ToString() Returns a string that represents the current object. Inherited from Object.
WriteDocx(TreeListSettings, Stream) static Exports the Tree List's data to a stream in DOCX format.
WriteDocx(TreeListSettings, Stream, DocxExportOptions) static Exports the Tree List's data to a stream in DOCX format with the specified export options.
WriteDocx(TreeListSettings, Object, Stream) static Exports the Tree List's data to a stream in DOCX format with the specified export options.
WriteDocx(TreeListSettings, Object, Stream, DocxExportOptions) static Exports the Tree List's data to a stream in DOCX format with the specified export options.
WritePdf(TreeListSettings, Stream) static Exports the TreeList's data to a stream in PDF with the specified export settings.
WritePdf(TreeListSettings, Stream, PdfExportOptions) static Exports the TreeList's data to a stream in PDF with the specified export settings.
WritePdf(TreeListSettings, Object, Stream) static Exports the TreeList's data to a stream in PDF with the specified export settings.
WritePdf(TreeListSettings, Object, Stream, PdfExportOptions) static Exports the TreeList's data to a stream in PDF with the specified export settings.
WriteRtf(TreeListSettings, Stream) static Exports the TreeList's data to a stream in RTF with the specified export settings.
WriteRtf(TreeListSettings, Stream, RtfExportOptions) static Exports the TreeList's data to a stream in RTF with the specified export settings.
WriteRtf(TreeListSettings, Object, Stream) static Exports the TreeList's data to a stream in RTF with the specified export settings.
WriteRtf(TreeListSettings, Object, Stream, RtfExportOptions) static Exports the TreeList's data to a stream in RTF with the specified export settings.
WriteXls(TreeListSettings, Stream) static Exports the TreeList's data to a stream in XLS with the specified export settings.
WriteXls(TreeListSettings, Stream, XlsExportOptions) static Exports the TreeList's data to a stream in XLS with the specified export settings.
WriteXls(TreeListSettings, Object, Stream) static Exports the TreeList's data to a stream in XLS with the specified export settings.
WriteXls(TreeListSettings, Object, Stream, XlsExportOptions) static Exports the TreeList's data to a stream in XLS with the specified export settings.
WriteXlsx(TreeListSettings, Stream) static Exports the TreeList's data to a stream in XLSX with the specified export settings.
WriteXlsx(TreeListSettings, Stream, XlsxExportOptions) static Exports the TreeList's data to a stream in XLSX with the specified export settings.
WriteXlsx(TreeListSettings, Object, Stream) static Exports the TreeList's data to a stream in XLSX with the specified export settings.
WriteXlsx(TreeListSettings, Object, Stream, XlsxExportOptions) static Exports the TreeList's data to a stream in XLSX with the specified export settings.
See Also