|
of_SetBackground
|
|
Full name
|
pfc_n_cst_dssrv_report.of_SetBackground
|
Access
|
public
|
Extend of
|
string
|
Return value
|
string
|
Prototype
|
public function string of_SetBackground(string,integer,integer)
|
public function string of_SetBackground (string as_filename, integer ai_x, integer ai_y);//////////////////////////////////////////////////////////////////////////////
//
// Function: of_SetBackground
//
// Access: public
//
// Arguments:
// as_FileName The name of the file containing the bitmap to display.
// ai_X The X location of the bitmap being placed, it will be
// centered horizontally if 0 is passed.
// ai_Y The Y location of the bitmap being placed, it will be
// centered vertically if 0 is passed.
//
// Returns: String
// The output of the Modify command (the error text or "") if True
// was passed for ab_Execute; the text of the Modify command
// to add the object if False was passed. Or one of the following errors:
// "Error! Invalid DW Unit" - DataWindow Unit is not PB Units or Pixels
// "Error! File not found" - The picture file does not exist
// "Error! Error calculating size" - Returned an error calculating the object size
//
// Description: Place a picture in the background of the DataWindow.
//
// This function overloads the real of_SetBackground to allow parameters to
// be optional. This version of the function assumes "SizeToFit" is False.
//
//////////////////////////////////////////////////////////////////////////////
//
// Revision History
//
// Version
// 5.0 Initial version
//
//////////////////////////////////////////////////////////////////////////////
//
// Copyright © 1996-1997 Sybase, Inc. and its subsidiaries. All rights reserved.
// Any distribution of the PowerBuilder Foundation Classes (PFC)
// source code by other than Sybase, Inc. and its subsidiaries is prohibited.
//
//////////////////////////////////////////////////////////////////////////////
Return of_SetBackground(as_FileName, False, ai_X, ai_Y, 0, 0, True)
end function