Class DocumentAdv
Represents the root element of the rich text contents.
Inherited Members
Namespace: Syncfusion.EJ.DocumentEditor
Assembly: Syncfusion.EJ.DocumentEditor.dll
Syntax
public class DocumentAdv : BaseNode
Constructors
DocumentAdv()
Initializes a new instance of the DocumentAdv class.
Declaration
public DocumentAdv()
Properties
AbstractLists
Gets or sets the abstract list collection of the DocumentAdv.
Declaration
public List<AbstractListAdv> AbstractLists { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<AbstractListAdv> |
BackgroundColor
Gets or sets the background color for the current document.
Declaration
public string BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CharacterFormat
Gets or Sets the character format.
Declaration
public CharacterFormat CharacterFormat { get; set; }
Property Value
Type | Description |
---|---|
CharacterFormat |
Lists
Gets or sets the list Collection the DocumentAdv.
Declaration
public List<ListAdv> Lists { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ListAdv> |
ParagraphFormat
Gets or Sets the paragraph format.
Declaration
public ParagraphFormat ParagraphFormat { get; set; }
Property Value
Type | Description |
---|---|
ParagraphFormat |
Sections
Gets or sets the section collection from the DocumentAdv.
Declaration
public List<SectionAdv> Sections { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<SectionAdv> |
Methods
Deserialize(String)
Converts a JSON-formatted string to an object of the DocumentAdv type.
Declaration
public static DocumentAdv Deserialize(string input)
Parameters
Type | Name | Description |
---|---|---|
System.String | input | The JSON string to deserialize. |
Returns
Type | Description |
---|---|
DocumentAdv | The deserialized DocumentAdv object. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | The input cannot be null. |
System.ArgumentException | The input is not a proper JSON string of DocumentAdv type. |
Dispose()
Releases unmanaged and - optionally - managed resources.
Declaration
public void Dispose()
Load(Stream, FormatType)
Loads the stream with the specified FormatType
Declaration
public static DocumentAdv Load(Stream stream, FormatType type)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The input stream. |
FormatType | type | The format type. |
Returns
Type | Description |
---|---|
DocumentAdv | The DocumentAdv instance. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | The input stream cannot be null. |
System.ArgumentException | The input stream is not a valid HTML supported by ejDocumentEditor. |
LoadHtml(String)
Loads the specified HTML string.
Declaration
public static DocumentAdv LoadHtml(string htmlString)
Parameters
Type | Name | Description |
---|---|---|
System.String | htmlString | The HTML string. |
Returns
Type | Description |
---|---|
DocumentAdv | The DocumentAdv instance. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | The input cannot be null. |
System.ArgumentException | The input is not a valid HTML supported by ejDocumentEditor. |
Save(Stream, FormatType)
Saves the content with the specified FormatType.
Declaration
public void Save(Stream stream, FormatType type)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | The stream. |
FormatType | type | The format type. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | The input stream cannot be null. |