Indy 9 | Content | Index | Reference

TIdLPRControlFile
Hierarchy, Properties, Methods, See Also, Unit: IdLPR
Encapsulates an LPR control file.

    TIdLPRControlFile = class(TPersistent)

Unit
IdLPR
Description
TIdLPRControlFile is a TPersistent descendant that encapsulates an LPR control file. An LPR control file specifies printing settings for a particular print job. TIdLPRControlFile is the type used to represent the TIdLPR.ControlFile property.

TIdLPRControlFile.BannerClass
TIdLPRControlFile
This is the class name to be printed on the banner page.

    property BannerClass: String;

Description
This is the class name to be printed on the banner page. The name must be 31 or fewer characters. The name can be omitted. If it is, the name of the host on which the file is printed will be used. The class is conventionally used to display the host from which the printing job originated.

TIdLPRControlFile.BannerPage
TIdLPRControlFile, See Also
Indicates that the LPR print job control contains a banner page.

    property BannerPage: Boolean;

Description
The BannerPage property indicates that the LPR print job control contains a banner page. Use the BannerClass property to identify the type of banner page required.

TIdLPRControlFile.FileFormat
TIdLPRControlFile
This property specifies the format of the file you are sending to the daemon.

    property FileFormat: TIdLPRFileFormat;

Description
This property specifies the format of the file you are sending to the daemon or how the file is to be printed by the daemon. This can be one of the following values:

- ffCIF - CalTech Intermediate Form

- ffDVI - DVI (TeX output)

- ffFormattedText - add formatting as needed to text file

- ffPlot - Berkeley Unix plot library

- ffControlCharText - text file with control characters

- ffDitroff - ditroff output

- ffPostScript - Postscript output file (.PS)

- ffPR - 'pr' format

- ffFORTRAM - FORTRAN carriage control

- ffTroff - Troff output

- ffSunRaster - Sun raster format file (.RAS, .RAST, .SUN, .SR, .SCR)

TIdLPRControlFile.HostName
TIdLPRControlFile
This is the name of the computer that requested the print job.

    property HostName: String;

Description
HostName is a String property that is the name of the computer that requested the print job. By default, this will be the address of the user's computer.

TIdLPRControlFile.IndentCount
TIdLPRControlFile, See Also
Specifies the column indenting count for the print job.

    property IndentCount: Integer;

Description
IndentCount is an Integer property that specifies the Indenting count for the print job. The Indenting count specifies the number of columns to indenting the content of the print job.

TIdLPRControlFile.JobName
TIdLPRControlFile, See Also
Specifies the job name to be printed on the banner page.

    property JobName: String;

Description
JobName is a String property that is the job name to be printed on the banner page for the print job.

TIdLPRControlFile.MailWhenPrinted
TIdLPRControlFile, See Also
Indicates the LPR daemon should mail the user when the print job is finished.

    property MailWhenPrinted: Boolean;

Description
MailWhenPrinted is a Boolean property that indicates if the LPR daemon should send mail to the user identified in UserName when the LPR print job is finished. The default value for MailWhenPrinted is False, as assigned in Create. MailWhenPrinted is used when TIdLPR generates a print stream including control data for a job.

TIdLPRControlFile.OutputWidth
TIdLPRControlFile, See Also
Specifies the maximum number of columns for the print job.

    property OutputWidth: Integer;

Description
OutputWidth is an Integer property that specifies the maximum number of columns for the print job.

Use IndentCount to specify the number of columns to use for the left margin of the print job.

TIdLPRControlFile.TroffBoldFont
TIdLPRControlFile, See Also
Indicates the font control settings for a Bold font in a print job.

    property TroffBoldFont: String;

Description
TroffBoldFont is a String property that indicates the control settings to use for a Bold font face when generating formatted text in a TIdLPR print job.

Use TroffRomanFont, TroffItalicFont, and TroffSpecialFont to specify other font settings for the print job.

TIdLPRControlFile.TroffItalicFont
TIdLPRControlFile, See Also
Indicates the font control settings for an Italic font in a print job.

    property TroffItalicFont: String;

Description
TroffItalicFont is a String property that indicates the control settings to use for an Italic font face when generating formatted text in a TIdLPR print job.

Use TroffBoldFont, TroffRomanFont, and TroffSpecialFont to specify other font settings for the print job.

TIdLPRControlFile.TroffRomanFont
TIdLPRControlFile, See Also
Indicates the font control settings for a Roman font in a print job.

    property TroffRomanFont: String;

Description
TroffRomanFont is a String property that indicates the control settings to use for a Roman font face when generating formatted text in a TIdLPR print job.

Use TroffBoldFont, TroffItalicFont, and TroffSpecialFont to specify other font settings for the print job.

TIdLPRControlFile.TroffSpecialFont
TIdLPRControlFile, See Also
Indicates the font control settings for Special fonts in a print job.

    property TroffSpecialFont: String;

Description
TroffSpecialFont is a String property that indicates the control settings to use for special fonts when generating formatted text in a TIdLPR print job.

Use TroffBoldFont, TroffItalicFont, and TroffRomanFont to specify other font settings for the print job.

TIdLPRControlFile.UserName
TIdLPRControlFile, See Also
This is the User name for the person who submitted the print job.

    property UserName: String;

Description
This is the User name for the person who submitted the print job or the user requesting that some of their jobs be deleted.

TIdLPRControlFile.Assign
TIdLPRControlFile
Copies values from one object to another object.

    procedure Assign(Source: TPersistent); override;

Parameters
Source: TPersistent
Object containing values to be copied.
Description
Assign is a procedure that copies the contents of a persistent object to the current object instance. Source is the object instance containing values to be copied.

When Source is an instance of TIdLPRControlFile, the following property values are copied into the current object:

- BannerClass

- IndentCount

- JobName

- BannerPage

- UserName

- OutputWidth

- FileFormat

- TroffRomanFont

- TroffItalicFont

- TroffBoldFont

- TroffSpecialFont

- MailWhenPrinted

When Source is another TPersistent calss descendant, Assign calls the inherited method using Source as an argument.

TIdLPRControlFile.Create
TIdLPRControlFile, See Also
Constructor for the TIdLPRControlFile object instance.

    constructor Create;

Description
Create is the constructor for the TIdLPRControlFile object instance. Create callsd the inherited Create method, and initializes values on the HostName, FileFormat, IndentCount, BannerPage, and OutputWidth properties. HostName can contain the value "unknown" if the local IP address or host name cannot be retrieved.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.