The base class for ScroogeXHTML. More...

Inheritance diagram for TSxBase:

Public Member Functions
	TSxBase ()
	Create a new TSxBase instance.

	TSxBase (TComponent AOwner)
	Create a new TSxBase instance.

	~TSxBase ()
	Destroy TSxBase instance.

	VerifySettings ()
	Checks properties for invalid settings. More...

string	GetCloseEmptyElement ()
	returns ' />' or '>' depending on DOCTYPE

string	GetEmptyParagraph ()
	returns an empty paragraph

string	GetParOpen ()
	returns the opening tag for a paragraph without ">"

string	GetOrderedListTag ()
	get the opening tag for an ordered list

string	GetUnorderedListTag ()
	get the opening tag for an unordered list

string	GetElementClassParam (const string ElementName)
	returns the class parameter for the given element

string	GetElementStyleParam (const string ElementName)
	returns the style="..." parameter for the given element

string	GetElementStyle (const string ElementName)
	returns the CSS style for the given element

string	GetLineBreakTag ()
	returns the line break element

	Log (const TLogLevel ALogLevel, const string ALogText)
	call the log event handler and pass the log level and message

	ReplaceFont (string &FontName)
	replace a font name

	ReplaceHyperlink (const ISimpleDomTextNode TextElement)
	replace a hyperlink

string	TextElementToXHTML (const ISimpleDomTextNode TextElement)
	convert a text element to HTML / XHTML. More...

Public Attributes
TSxBase public properties
These properties are not visible in the Object Inspector, except OptionsHead and OptionsOptimize.
Boolean	AbortConversion
	set this property to True to abort the conversion More...

ISxFormatter	Formatter
	The formatter. More...

IPictureAdapter	PictureAdapter
	The picture adapter. More...

Boolean	RtfEnd
	True -> end of document or conversion aborted. More...

ISxTranslator	Translator
	The HTML / XHTML Translator. More...

TSxBase published properties
These properties are visible in the Object Inspector.
Boolean	ConvertAnchors
	Activates support for anchor conversion. More...

Boolean	ConvertEmptyParagraphs
	Set this property to True to replace empty paragraphs (where the opening <p> tag is followed by the closing </p> tag) by a line break tag (<br />). More...

Boolean	ConvertFields
	Activates support for field conversion. More...

Boolean	ConvertHyperlinks
	Set this property to True to activate hyperlink support. More...

Boolean	ConvertIndent
	Set this property to True if You want to activate support for left and right paragraph indent. More...

Boolean	ConvertLanguage
	Activates support for language conversion. More...

Boolean	ConvertPictures
	Activates support for picture conversion. More...

Boolean	ConvertSpaces
	If two or more spaces are found in sequence, they will be converted to  . More...

Boolean	ConvertToPlainText
	Convert to plain text. More...

Boolean	ConvertUsingPrettyIndents
	ScroogeXHTML generates output documents with 'pretty printed' formatting by default. More...

string	DefaultLanguage
	Use this property to set the default language of the document. More...

TDocumentType	DocumentType
	The document type. More...

TStrings	ElementClasses
	A list of name-value pairs which defines the class="..." parameter for the elements 'p', 'br', 'ol', 'ul' and 'li'. More...

TStrings	ElementStyles
	A list of name-value pairs which defines the style="..." parameter for the elements 'p', 'br', 'ol', 'ul' and 'li'. More...

TFontConversionOptions	FontConversionOptions
	Set these options to control which character properties are converted. More...

TFontSizeScale	FontSizeScale
	Use this option to set the font size scale. More...

TStrings	HyperlinkList
	In this list of name value pairs, the visible link text for all known target addresses is associated with an URL. More...

THyperlinkOptions	HyperlinkOptions
	This property controls additional options for the hyperlink conversion. More...

Boolean	IncludeDocType
	Include DOCTYPE at the beginning of the document. More...

Boolean	IncludeXMLDeclaration
	Includes the XML declaration line at the beginning of the document. More...

TLogLevel	LogLevel
	This property can be used to control the detail level of the logging procedure. More...

TStrings	ReplaceFonts
	Font names which will be replaced. More...

string	TabString
	the HTML representation of a TAB charcter More...

string	Version
	the ScroogeXHTML version More...

TSxOptionsHead	OptionsHead

TSxOptionsOptimize	OptionsOptimize

TSxBase events
TNotifyEvent	OnAfterConvert
	This event handler will be called after the conversion. More...

TEncodingEvent	OnAfterEncode
	Event handler which will be called after the encoding. More...

TNotifyEvent	OnBeforeConvert
	Event handler which will be called before the conversion. More...

TEncodingEvent	OnBeforeEncode
	Event handler which will be called before the encoding. More...

THyperlinkEvent	OnHyperlink
	This event handler will be called if a hyperlink is detected. More...

TLogEvent	OnLog
	Event handler for log messages. More...

TProgressEvent	OnProgress
	This event is called periodically during the conversion. More...

TReplaceFontEvent	OnReplaceFont
	This event handler can be used to define a font substition. More...

Detailed Description

The base class for ScroogeXHTML.

Member Function Documentation

◆ TextElementToXHTML()

string TSxBase::TextElementToXHTML ( const ISimpleDomTextNode TextElement )

Initial value:

{
 
}

convert a text element to HTML / XHTML.

This function receives a block of text and its attributes, packaged in a ISimpleDomTextNode object. It will then

call OnBeforeEncode (with the text block as parameter)
if IncludeDefaultFontStyle: clear the default font properties
do special processing for the 'Symbol' font
use the TCustomTranslator::encode method to convert the text to UTF-8
if ConvertHyperlinks: search and process a hyperlink
if ConvertSpaces: replace ' ' with  
call OnAfterEncode
call TCustomTranslator::formatElement

◆ VerifySettings()

TSxBase::VerifySettings ( )

Checks properties for invalid settings.

Will throw an Exception to indicate bad values.

Member Data Documentation

◆ AbortConversion

Boolean TSxBase::AbortConversion

set this property to True to abort the conversion

See also: FAbortConversion For reading; SetAbortConversion For writing

◆ ConvertAnchors

Boolean TSxBase::ConvertAnchors

Activates support for anchor conversion.

See also: FConvertAnchors For reading; FConvertAnchors For writing

◆ ConvertEmptyParagraphs

Boolean TSxBase::ConvertEmptyParagraphs

Set this property to True to replace empty paragraphs (where the opening <p> tag is followed by the closing </p> tag) by a line break tag (<br />).

Default: false

See also: FConvertEmptyParagraphs For reading; FConvertEmptyParagraphs For writing

◆ ConvertFields

Boolean TSxBase::ConvertFields

Activates support for field conversion.

See also: FConvertFields For reading; FConvertFields For writing

◆ ConvertHyperlinks

Boolean TSxBase::ConvertHyperlinks

Set this property to True to activate hyperlink support.

Default: false

Note: Hyperlinks are detected if they use formatted blue and underlined in the source document or if the text contains a HYPERLINK field expression; If the OnHyperlink event handler is assigned, only the event handler will be executed, and all options defined in the property HyperlinkOptions have no effect.

See also: FConvertHyperlinks For reading; FConvertHyperlinks For writing

◆ ConvertIndent

Boolean TSxBase::ConvertIndent

Set this property to True if You want to activate support for left and right paragraph indent.

Default: false

Note: the right indent in the output document is relative to the browser window, if you change the browser window size, the text area will adjust its size

See also: FConvertIndent For reading; FConvertIndent For writing

◆ ConvertLanguage

Boolean TSxBase::ConvertLanguage

Activates support for language conversion.

See also: GetConvertLanguage For reading; FConvertLanguage For writing

◆ ConvertPictures

Boolean TSxBase::ConvertPictures

Activates support for picture conversion.

See also: FConvertPictures For reading; FConvertPictures For writing

◆ ConvertSpaces

Boolean TSxBase::ConvertSpaces

If two or more spaces are found in sequence, they will be converted to  .

See also: FConvertSpaces For reading; FConvertSpaces For writing

◆ ConvertToPlainText

Boolean TSxBase::ConvertToPlainText

Convert to plain text.

See also: FConvertToPlainText For reading; FConvertToPlainText For writing

◆ ConvertUsingPrettyIndents

Boolean TSxBase::ConvertUsingPrettyIndents

ScroogeXHTML generates output documents with 'pretty printed' formatting by default.

Some web browsers however have problems with line breaks between html tags, which cause rendering errors. To provide support for more web browsers, the ConvertUsingPrettyIndents property should be set to false. Default: True for backward compatibility

See also: FConvertUsingPrettyIndents For reading; SetConvertUsingPrettyIndents For writing

◆ DefaultLanguage

string TSxBase::DefaultLanguage

Use this property to set the default language of the document.

See also: GetDefaultLanguage For reading; FDefaultLanguage For writing

◆ DocumentType

TDocumentType TSxBase::DocumentType

The document type.

For the selected document type, the component will instantiate an object which implements the ISxTranslator interface and assign it to the public Translator property.

Note: Depending on the document type, some HTML/XHTML elements or parameters are not supported.

See also: FDocumentType For reading; SetDocumentType For writing

◆ ElementClasses

TStrings TSxBase::ElementClasses

A list of name-value pairs which defines the class="..." parameter for the elements 'p', 'br', 'ol', 'ul' and 'li'.

See also: FElementClasses For reading

◆ ElementStyles

TStrings TSxBase::ElementStyles

A list of name-value pairs which defines the style="..." parameter for the elements 'p', 'br', 'ol', 'ul' and 'li'.

See also: FElementStyles For reading

◆ FontConversionOptions

TFontConversionOptions TSxBase::FontConversionOptions

Set these options to control which character properties are converted.

opFontSize enables conversion of font sizes. Default: enabled.
opFontName enables conversion of font names. See also TCustomScrooge::ReplaceFonts . Default: enabled.
opFontStyle enables conversion of font styles (bold, italic, underlined, strikeout). Default: enabled.
opFontColor enables conversion of font colors. Default: enabled
opFontBGColor enables conversion of background font colors. Default: enabled.
opFontHLColor enables conversion of highlight font colors. Default: disabled.
See also
GetFontConversionOptions For reading

FFontConversionOptions For writing

◆ FontSizeScale

TFontSizeScale TSxBase::FontSizeScale

Use this option to set the font size scale.

The following units are supported:

point (pt)
em
ex
percent
Note
Point is an absolute size scale, all others are relative scales.

See also
FFontSizeScale For reading

FFontSizeScale For writing

◆ Formatter

TSxBase::Formatter

The formatter.

See also: FFormatter For reading

◆ HyperlinkList

TStrings TSxBase::HyperlinkList

In this list of name value pairs, the visible link text for all known target addresses is associated with an URL.

Note

HyperlinkList works only with link text if it is formatted blue and underlined.
ConvertHyperlinks and HyperlinkOptions hoUseHyperlinkList option have to be enabled

See also: FHyperlinkList For reading; SetHyperlinkList For writing

◆ HyperlinkOptions

THyperlinkOptions TSxBase::HyperlinkOptions

This property controls additional options for the hyperlink conversion.

hoOpenInNewBrowser the target page will be opened in a new browser window. This option works only in HTML/XHTML Transitional mode, the Strict mode does not support the target-parameter. Default: false
hoReplaceEMailLinks e-mail links will be replaced by a 'mailto:' - link. Default: false
hoUseHyperlinkList the HyperlinkList will used. Default: false
hoRequireHTTP the link will be replaced even if the link text does not start with 'http:'
Note
if the OnHyperlink event handler is assigned to a custom method, all settings of the HyperlinkOptions property will have no effect.

The ConvertHyperlink property has to be set to True.

See also
FHyperlinkOptions For reading

FHyperlinkOptions For writing

◆ IncludeDocType

Boolean TSxBase::IncludeDocType

Include DOCTYPE at the beginning of the document.

Default: True.

Note: Some HTML browsers check this element, and use the information in it to verify the document code.; XHTML 1.1 will always be generated with DOCTYPE.

See also: FIncludeDocType For reading; FIncludeDocType For writing

◆ IncludeXMLDeclaration

Boolean TSxBase::IncludeXMLDeclaration

Includes the XML declaration line at the beginning of the document.

Default: False

* <?xml version="1.0"?>

Note: the default encodig for documents which use this declaration is UTF-8

See also: FIncludeXMLDeclaration For reading; FIncludeXMLDeclaration For writing

◆ LogLevel

TLogLevel TSxBase::LogLevel

This property can be used to control the detail level of the logging procedure.

Default: logInfo

See also: FLogLevel For reading; FLogLevel For writing

◆ OnAfterConvert

TNotifyEvent TSxBase::OnAfterConvert

This event handler will be called after the conversion.

See also: FOnAfterConvert For reading; FOnAfterConvert For writing

◆ OnAfterEncode

TEncodingEvent TSxBase::OnAfterEncode

Event handler which will be called after the encoding.

See also: FOnAfterEncode For reading; FOnAfterEncode For writing

◆ OnBeforeConvert

TNotifyEvent TSxBase::OnBeforeConvert

Event handler which will be called before the conversion.

See also: FOnBeforeConvert For reading; FOnBeforeConvert For writing

◆ OnBeforeEncode

TEncodingEvent TSxBase::OnBeforeEncode

Event handler which will be called before the encoding.

See also: FOnBeforeEncode For reading; FOnBeforeEncode For writing

◆ OnHyperlink

THyperlinkEvent TSxBase::OnHyperlink

This event handler will be called if a hyperlink is detected.

It can be used to modify the hyperlink text.

Note: if the OnHyperlink event handler is assigned to a custom method, all settings of the HyperlinkOptions property will have no effect.; The ConvertHyperlink property has to be set to True.

See also: FOnHyperlink For reading; FOnHyperlink For writing

◆ OnLog

TLogEvent TSxBase::OnLog

Event handler for log messages.

See also: LogLevel; FOnLog For reading; FOnLog For writing

◆ OnProgress

TProgressEvent TSxBase::OnProgress

This event is called periodically during the conversion.

It can be used to display the conversion progress.

: Example:
procedure TfrmMain.converterProgress(Sender: TObject;

const Position: Integer; var continue: Boolean);

begin

Label1.Caption := IntToStr(Position)+'%';

Application.ProcessMessages;

end;

See also: FOnProgress For reading; FOnProgress For writing

◆ OnReplaceFont

TReplaceFontEvent TSxBase::OnReplaceFont

This event handler can be used to define a font substition.

See also: FOnReplaceFont For reading; FOnReplaceFont For writing

◆ OptionsHead

TSxOptionsHead TSxBase::OptionsHead

See also: FOptionsHead For reading; SetOptionsHead For writing

◆ OptionsOptimize

TSxOptionsOptimize TSxBase::OptionsOptimize

See also: GetOptionsOptimize For reading; SetOptionsOptimize For writing

◆ PictureAdapter

IPictureAdapter TSxBase::PictureAdapter

The picture adapter.

See also: GetPictureAdapter For reading; FPictureAdapter For writing

◆ ReplaceFonts

TSxBase::ReplaceFonts

Font names which will be replaced.

See also: FReplaceFonts For reading; SetReplaceFonts For writing

◆ RtfEnd

Boolean TSxBase::RtfEnd

True -> end of document or conversion aborted.

See also: FRtfEnd For reading; FRtfEnd For writing

◆ TabString

string TSxBase::TabString

the HTML representation of a TAB charcter

See also: GetTabString For reading; FTabString For writing

◆ Translator

ISxTranslator TSxBase::Translator

The HTML / XHTML Translator.

Note: To change the Translator, please use the DocumentType property.

See also: FTranslator For reading

◆ Version

string TSxBase::Version

the ScroogeXHTML version

See also: false For reading

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ TextElementToXHTML()

◆ VerifySettings()

Member Data Documentation

◆ AbortConversion

◆ ConvertAnchors

◆ ConvertEmptyParagraphs

◆ ConvertFields

◆ ConvertHyperlinks

◆ ConvertIndent

◆ ConvertLanguage

◆ ConvertPictures

◆ ConvertSpaces

◆ ConvertToPlainText

◆ ConvertUsingPrettyIndents

◆ DefaultLanguage

◆ DocumentType

◆ ElementClasses

◆ ElementStyles

◆ FontConversionOptions

◆ FontSizeScale

◆ Formatter

◆ HyperlinkList

◆ HyperlinkOptions

◆ IncludeDocType

◆ IncludeXMLDeclaration

◆ LogLevel

◆ OnAfterConvert

◆ OnAfterEncode

◆ OnBeforeConvert

◆ OnBeforeEncode

◆ OnHyperlink

◆ OnLog

◆ OnProgress

◆ OnReplaceFont

◆ OptionsHead

◆ OptionsOptimize

◆ PictureAdapter

◆ ReplaceFonts

◆ RtfEnd

◆ TabString

◆ Translator

◆ Version