# Type TIncludeType

## Declaration

TIncludeType = procedure (Sender: TObject; const Command: string;

Params: TStrings; var IString: string) of Object;

## Description

The TIncludeType type is the type for OnInclude events. These events occur when server side include syntax is encountered in the HTML document at load time.

The server side include syntax takes the form:

<!--#command arg1="value1" arg2="value2" ... -->

The '#' distinguishes this syntax from an ordinary comment. The command word appears as the Command parameter in the event call. The command word may be followed by zero or more arg,value pairs. These are formed into a TStringList object to make up the Params parameter. For use in THtmlViewer, TFrameViewer, TFrameBrowzer, the parameters can be anything that's convenient.

The HTML text to be inserted is passed back in IString. This string replaces the entire original include statement.

Note that:

Quotes are stripped from the Value parts of Params.

The event handler should contain a Params.Free; statement. Since version 11.1 freeing Params is done by THtmlViewer, TFrameViewer, resp. TFrameBrowser and you MUST NOT do it.

See also:

OnInclude Event