IgtDocumentSettings Interface

IgtDocumentSettings types define properties and methods that specify settings for content creation.

Pascal

public IgtDocumentSettings = interface(IUnknown);

C++

public: __interface IgtDocumentSettings : public IUnknown;

Class Hierarchy

File

gtCstDocEng

Members

Properties

	Name	Description
	BackgroundColor	Specifies background color of the document.
	BackgroundImage	Specifies background image of the document.
	BackgroundImageDisplayType	Specifies position of background image.
	Brush	Specifies brush used to fill various page elements in the document.
	DefaultFont	Specifies default font used for rendering text in the document.
	DocInfo	Specifies generic document information properties for all engines.
	FileDescription	Specifies text identifying the output format.
	FileExtension	Specifies file extension for the output document.
	FileName	Specifies filename of the document.
	Font	Specifies default font used for text elements in the document.
	Frame	Specifies border settings for images and text boxes in the document.
	ImageSettings	Specifies image settings for the document.
	Page	Specifies page settings.
	PageBorder	Specifies settings for page borders.
	Pen	Specifies pen used to stroke page elements in the document.
	Preferences	Specifies document creation settings of the engine.
	TableSettings	Specifies settings for tables.
	TextFormatting	Specifies text formatting settings.

Methods

	Name	Description
	GetBackgroundColor	Returns current background color of the document.
	GetBackgroundDisplayType	Returns current position of background image for the document.
	GetBackgroundImage	Returns current background image of the document.
	GetBrush	Returns current brush used to filling page elements in the document.
	GetDefaultFont	Returns default font used in the document.
	GetDocInfo	Returns current document information properties of the document.
	GetFileDescription	Returns string containing the description metadata for the current document.
	GetFileExtension	Returns current file extension of the current document.
	GetFileName	Returns file name of the document.
	GetFont	Returns current font used to render text in the document.
	GetFrame	Returns current border settings used for images and text boxes in the document.
	GetImageSettings	Returns current image settings for the document.
	GetPage	Returns current page settings for the document.
	GetPageBorder	Returns current border settings for pages in the document.
	GetPen	Returns pen used to stroke page elements on the document.
	GetPreferences	Returns current engine settings.
	GetTableSettings	Returns current table settings.
	GetTextFormatting	Returns current text formatting settings for text rendered on the document.
	SetBackgroundColor	Sets specified color for the background of the document.
	SetBackgroundDisplayType	Sets specified position for the background image of the document.
	SetBackgroundImage	Sets specified image for the background of the document.
	SetBrush	Sets specified brush for text rendering operations on the document.
	SetDefaultFont	Sets specified font for text elements in the document.
	SetDocInfo	Sets specified document information properties for the document.
	SetFileDescription	Sets specified text string as the description of the document.
	SetFileExtension	Sets specified extension for the document.
	SetFileName	Sets specified file name for the document.
	SetFont	Sets specified default font for the document.
	SetFrame	Sets specified border for images and text boxes in the document.
	SetImageSettings	Sets specified image settings for the document.
	SetPage	Sets specified page settings for the document.
	SetPageBorder	Sets specified border settings for pages in the document.
	SetPen	Sets specified pen for stroking page elements in the document.
	SetPreferences	Sets specified settings for the engine.
	SetTableSettings	Sets specified table settings for the document.
	SetTextFormatting	Sets specified text formatting for the document.