Home » Development Area » DigiGuide Print Script » API Index


General

Classes
OptionsPrint options specified on the print popup.
Functions
 FormatTime Format a time
 GetMarkerInfo Get marker details by using marker tags
 GetOptionValue Get an option value for this template.

Drawing

Functions
 DrawBox Draw a box of the specified location and size
 DrawEllipsisText Draws text in the current font with ... if it's too small.
 DrawImage Draws an image.
 GetCurrentFontHeight Returns the height, in pixels, of the current font.
 GetTextWidth Returns the width, in pixels, of strText.
 MeasureText Returns the height of strText given a constraining nWidth.
 PlaceText Draw text onto the page
 SelectFont Change the current font.

Programme

Functions
 DoesChannelLogoExist Determie if a logo exists for the channel ID passed
 GetChannelListFromProgrammes Extract a list of channel IDs from the current programmes
 GetMarkersForProgramme Get an Array of marker IDs for the passed programme
 GetProgrammeCount Returns the number of programmes available to this report.
 GetProgrammeInfo Get programme info in a specially tagged string.
 GetProgrammeListForChannelDateRange Get a list of programme indexes given a date/time range
 IsProgrammeExcludedFromMarker Determine if the programme is excluded from the passed marker
 IsProgrammeMarked Determine if the programme is marked by any markers
 IsProgrammeMarkedByType Determine if the programme is marked by a type of marker
 ShouldIncludeProgrammeDescription Determine whether the programme passed should have it's description displayed.

System

Functions
 GetBitsPerPixel Determine the number of bits per pixel
 GetPageHeight Get the height, in pixels, of the printer page
 GetPageWidth Get the width, in pixels, of the printer page.
 GetPixelsPerInchX Determine number of horizontal pixels per inch for the printer device.
 GetPixelsPerInchY Determine number of vertical pixels per inch for the printer device.
 HasAborted Determine if the user has aborted printing.
 NewPage Throws a new printer page.
 SetProgress Set the progress bar

(Last updated: September 16, 2011 10:27:33)