Class HtmlExportSettings

Provides different settings that are applied while exporting a RadDocument instance to HTML.

Inheritance
System.Object
HtmlExportSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents.FormatProviders.Html
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class HtmlExportSettings

Constructors

HtmlExportSettings()

Initializes a new instance of the HtmlExportSettings class.

Declaration
public HtmlExportSettings()

Properties

DocumentExportLevel

Gets or sets which element tags should be exported.

Declaration
public DocumentExportLevel DocumentExportLevel { get; set; }
Property Value
DocumentExportLevel

The document export level.

ExportBoldAsStrong

Gets or sets a value indicating whether the font-weight: bold should be exported as tag strong.

Declaration
public bool ExportBoldAsStrong { get; set; }
Property Value
System.Boolean

true if the font-weight should be exported as tag strong.; otherwise, false.

ExportEmptyDocumentAsEmptyString

Gets or sets a value indicating whether empty document should be exported as empty string.

Declaration
public bool ExportEmptyDocumentAsEmptyString { get; set; }
Property Value
System.Boolean

true if empty document should be exported as empty string; otherwise, false.

ExportFontStylesAsTags

Gets or sets a value indicating whether the font styles: bold, italic and underline should be exported as tags.

Declaration
public bool ExportFontStylesAsTags { get; set; }
Property Value
System.Boolean

true if the font styles should be exported as tags; otherwise, false.

ExportHeadingsAsTags

Gets or sets a value indicating whether Heading styles should be exported as HTML heading styles (h1, h2 etc.)

Declaration
public bool ExportHeadingsAsTags { get; set; }
Property Value
System.Boolean

true if Heading styles should be exported as HTML heading styles; otherwise, false.

ExportItalicAsEm

Gets or sets a value indicating whether the font-style: italic should be exported as tag em.

Declaration
public bool ExportItalicAsEm { get; set; }
Property Value
System.Boolean

true if the font-style should be exported as tag em; otherwise, false.

ExportLocalOrStyleValueSource

Gets or sets if RadRichTextBox should export only properties which has local or style value source.

Declaration
public bool ExportLocalOrStyleValueSource { get; set; }
Property Value
System.Boolean

true if properties with local or style value source should be exported; otherwise, false.

ExportStyleMetadata

Gets or sets a value indicating whether an additional metadata should be added when exporting CSS classes. This metadata can be used later when importing.

Declaration
public bool ExportStyleMetadata { get; set; }
Property Value
System.Boolean

true if the additional metadata should be exported; otherwise, false.

ForbiddentPropertiesForExportCollection

Gets collection where you can add properties which won't be exported for certain HTML tag.

Declaration
[Obsolete("Use PropertiesToIgnore instead of this property.")]
public Dictionary<string, List<string>> ForbiddentPropertiesForExportCollection { get; }
Property Value
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Remarks

Gets collection where you can add properties which won't be exported for certain HTML tag.

ImageExportMode

Gets or sets the image export mode.

Declaration
public ImageExportMode ImageExportMode { get; set; }
Property Value
ImageExportMode

The image export mode.

PropertiesToIgnore

Gets a collection where you can add properties which will not be exported for a certain HTML tag.

Declaration
public Dictionary<string, List<string>> PropertiesToIgnore { get; }
Property Value
System.Collections.Generic.Dictionary<System.String, System.Collections.Generic.List<System.String>>

Remarks

Gets a collection where you can add properties which will not be exported for a certain HTML tag.

SpanExportMode

Gets or sets the span export mode. This option will not affect the content of the span but only how the span tag is exported.

Declaration
public SpanExportMode SpanExportMode { get; set; }
Property Value
SpanExportMode

The span export mode.
Remarks

Controls how the span tag is exported.

StyleRepositoryExportMode

Gets or sets the style repository export mode.

Declaration
public StyleRepositoryExportMode StyleRepositoryExportMode { get; set; }
Property Value
StyleRepositoryExportMode

The style repository export mode.
Remarks

Controls how the style repository of the document is exported to HTML.

StylesExportMode

Gets or sets the styles export mode. This controls how the properties of the document elements will be exported.

Declaration
public StylesExportMode StylesExportMode { get; set; }
Property Value
StylesExportMode

The styles export mode.
Remarks

Gets or sets the styles export mode. This controls how the properties of the document elements will be exported.

Title

Gets or sets the title of the generated HTML file.

Declaration
public string Title { get; set; }
Property Value
System.String

The title.

Events

CssClassExporting

Occurs when a CSS class is being exported.

Declaration
public event EventHandler<CssClassExportingEventArgs> CssClassExporting
Event Type
System.EventHandler<CssClassExportingEventArgs>

FloatingUIContainerExporting

Occurs when an FloatingUIContainer is being exported. You can use this event to customize the container and the way it is exported.

Declaration
public event EventHandler<FloatingUIContainerExportingEventArgs> FloatingUIContainerExporting
Event Type
System.EventHandler<FloatingUIContainerExportingEventArgs>

ImageExporting

Occurs when an image is being exported. You can use this event to customize the image.

Declaration
public event EventHandler<ImageExportingEventArgs> ImageExporting
Event Type
System.EventHandler<ImageExportingEventArgs>

InlineUIContainerExporting

Occurs when an InlineUIContainer is being exported. You can use this event to customize the container and the way it is exported.

Declaration
public event EventHandler<InlineUIContainerExportingEventArgs> InlineUIContainerExporting
Event Type
System.EventHandler<InlineUIContainerExportingEventArgs>

Extension Methods