SAPGuiCalendar Object

Description

A calendar object in an SAP GUI for Windows application.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SAPGuiCalendar object.

Note: You can also view a list and descriptions of the SAPGuiCalendar description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROPropertyReturns the current value of the description property from the object in the application.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetDateSelects a single date in a calendar in an SAP GUI for Windows application.
Method SetDateRangeSelects a date range in a calendar in an SAP GUI for Windows application.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.
Common Property ObjectAccesses the native methods and properties of the object.

Back to top

 

SetDate Method

Description

Selects a single date in a calendar in an SAP GUI for Windows application.

Syntax

object.SetDate (Date)

Arguments

ParameterDescription
Date Required. A String value.
The date to be set for the calendar. The date is entered as a string in the format d/MMM/yyyy, where d is the one- or two-digit day, MMM is the three-character month abbreviation, and yyyy is the full four-digit year.

Return Type

None.

Example

Back to top

 

SetDateRange Method

Description

Selects a date range in a calendar in an SAP GUI for Windows application.

Syntax

object.SetDateRange (FirstDate, LastDate)

Arguments

ParameterDescription
FirstDate Required. A String value.
The start date of a date range, in the format d/mmm/yyyy, where d is the one- or two-digit day, mmm is the three-character month abbreviation, and yyyy is the full four-digit year. Example: 17/Feb/2003.
LastDate Required. A String value.
The end date of a date range, in the format d/mmm/yyyy, where d is the one- or two-digit day, mmm is the three-character month abbreviation, and yyyy is the full four-digit year.
Example: 24/Feb/2003

Return Type

None.

IMPORTANT

The actual date range can be one full week or one full month.

  • If you specify a range of seven days or less between the start and end dates, the method applies the week containing the date you specify for theFirstDate argument. For example, if the FirstDate is 10/Dec/2004 and the LastDate is 14/Dec/2004, the method applies the week of 06/Dec/2004 through 12/Dec/2004.

    Note: The SAP GUI for Windows application calculates a week from Monday through Sunday.

  • If you specify a range of more than seven days between the start and end dates, the method applies the relevant month. For example, if the FirstDate is 10/Dec/2004 and the LastDate is 24/Dec/2004, the method applies the month of December (from 01/Dec/2004 through 31/Dec/2004).
      
  • If you specify a range of more than seven days between the start and end dates, and the dates span more than one month (for example, 23/Nov/2004 through 14/Dec/2004), the SAP GUI for Windows application applies internal calculations to determine the relevant month to apply.

Example

Back to top

See also: