SiebCalendar Object

Description

A calendar control in a Siebel test automation environment.

Operations

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

Note: You can also view a list and descriptions of the SiebCalendar 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

Method CancelPopupCloses the calendar popup applet without saving changes (for example, by clicking the Cancel button).
Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified 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.

Method ClosePopupCloses the calendar popup applet after saving changes (for example, by clicking the Save button).
Common Method GetROPropertyReturns the current value of the specified 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.
Method NextMonthChanges the displayed month in the calendar popup applet to the next month (for example, from February to March).
Method OpenPopupOpens the calendar popup applet.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method PrevMonthChanges the displayed month in the calendar popup applet to the previous month (for example, from April to March).
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SelectTimeZoneSets the Time Zone in the open calendar popup applet.
Method SetDaySets the Day in the open calendar popup applet.
Method SetMonthSets the Month in the open calendar popup applet.
Method SetTextEnters text in the parent control for the calendar.
Method SetTimeSets the Time in the open calendar popup applet.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method SetYearSets the Year in the open calendar popup applet.
Common Method ToStringReturns a string that represents the current 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

Property CalendarTypeThe type of calendar.
Property ClassNameThe class of the object.
Property DayThe current day in the open calendar control.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsEnabledIndicates whether the object is enabled.
Property IsOpenIndicates whether the associated popup applet is open.
Property IsRequiredIndicates whether the object is required.
Property MonthThe current month in the open calendar control.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property TextThe text value of the object.
Property TimeThe current time in the open calendar control.
Property TimeZoneThe current time zone in the open calendar control.
Property TimeZoneCountThe number of time zones in the time zone picklist for the open calendar control.
Property UINameThe name of the object as it is appears in the user interface.
Property YearThe current year in the open calendar control.

Back to top

 

CancelPopup Method

Description

Closes the calendar popup applet without saving changes (for example, by clicking the Cancel button).

Syntax

object.CancelPopup

Return Type

None.

Example

                    'The following example uses the CancelPopup method to confirm that the
'"Start" calendar's "Cancel" button properly cancels any changes made
'in the pop-up object.

'Store the text from the calendar before opening it.
var_Text_orig = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
'Open the calendar pop-up and change the date.
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").NextMonth
'Click the Cancel button to close the pop-up without saving changes.
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").CancelPopup
'Store the text from the calendar after cancelling the pop-up.
var_Text_after = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
'Confirm that date did not change after clicking Cancel.
If var_Text_orig = var_Text_after Then
    Reporter.ReportEvent 1, "Calendar Cancel button  ", "Properly cancels the changes."
Else
    Reporter.ReportEvent 0, "Calendar Cancel button  ", "Does not work properly."
End If

Back to top

 

ClosePopup Method

Description

Closes the calendar popup applet after saving changes (for example, by clicking the Save button).

Syntax

object.ClosePopup

Return Type

None.

Example

                    'The following example uses the ClosePopup method to close the "Start"
'calendar after setting the date, time, and time zone on the calendar.
 
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
var_CalendarType = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").CalendarType
If var_CalendarType = "DateTimeZone" Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup
 End If

Back to top

 

NextMonth Method

Description

Changes the displayed month in the calendar popup applet to the next month (for example, from February to March).

Syntax

object.NextMonth

Return Type

None.

IMPORTANT

Before running this method, ensure that the calendar is open in the application.  For example, add a SiebCalendar.OpenPopup method immediately prior to the NextMonth step, or include the NextMonth step in an If statement that checks whether the calendar exists.

Example

                    'The following example uses the NextMonth property to set the calendar
'forward one month.  The example confirms that the month has changed, and
'then returns the calendar to its original month.

SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
var_Month_orig = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").NextMonth
var_Month_next = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
If var_Month_orig = var_Month_next Then
    Reporter.ReportEvent 1, "SiebCalendar.NextMonth method  ", "Was not performed."
Else
    Reporter.ReportEvent 0, "SiebCalendar.NextMonth method  ", "Changed the month setting."
End If
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth var_Month_orig

Back to top

 

OpenPopup Method

Description

Opens the calendar popup applet.

Syntax

object.OpenPopup

Return Type

None.

Example

                    'The following example uses the OpenPopup method to open the "Start"
'calendar and then set the date, time, and time zone on the calendar.
 
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
var_CalendarType = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").CalendarType
If var_CalendarType = "DateTimeZone" Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup
 End If

Back to top

 

PrevMonth Method

Description

Changes the displayed month in the calendar popup applet to the previous month (for example, from April to March).

Syntax

object.PrevMonth

Return Type

None.

IMPORTANT

Before running this method, ensure that the calendar is open in the application.  For example, add a SiebCalendar.OpenPopup method immediately prior to the PrevMonth step, or include the PrevMonth step in an If statement that checks whether the calendar exists.

Example

                    'The following example uses the PrevMonth property to set the calendar
'back one month.  The example confirms that the month has changed, and
'then returns the calendar to its original month.

SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
var_Month_orig = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").PrevMonth
var_Month_prev = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
If var_Month_orig = var_Month_prev Then
    Reporter.ReportEvent 1, "SiebCalendar.PrevMonth method  ", "Was not performed."
Else
    Reporter.ReportEvent 0, "SiebCalendar.PrevMonth method  ", "Changed the month setting."
End If
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth var_Month_orig

Back to top

 

SelectTimeZone Method

Description

Sets the Time Zone in the open calendar popup applet.

Syntax

object.SelectTimeZone (ItemName)

Arguments

ParameterDescription
ItemName Required. A String value.
The Time Zone value in the format "(GMT-09:00) Alaska".

Return Type

None.

Example

                    'The following example uses the SelectTimeZone method to set the time zone
'on the "Start" calendar.
  
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup

Back to top

 

SetDay Method

Description

Sets the Day in the open calendar popup applet.

Syntax

object.SetDay (Day)

Arguments

ParameterDescription
Day Required. A long integer value.
The new day value.

Return Type

None.

Example

                    'The following example uses the SetDay method to set the date on the
'"Start" calendar.
  
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup

Back to top

 

SetMonth Method

Description

Sets the Month in the open calendar popup applet.

Syntax

object.SetMonth (Month)

Arguments

ParameterDescription
Month Required. A long integer value.
The new month value.

Return Type

None.

Example

                    'The following example uses the SetMonth method to set the date on the
'"Start" calendar.
  
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup

Back to top

 

SetText Method

Description

Enters text in the parent control for the calendar.

Syntax

object.SetText (Text)

Arguments

ParameterDescription
Text Required. A String value.
The text to enter

Return Type

None.

Example

                    'The following example uses the SetText method to set the current date in
'the "Close Date" calendar.

var_CalendarType = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").CalendarType
If var_CalendarType = "Date" Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").SetText Trim(Date)
End If

Back to top

 

SetTime Method

Description

Sets the Time in the open calendar popup applet.

Syntax

object.SetTime (Time)

Arguments

ParameterDescription
Time Required. A String value.
The new time value.

Return Type

None.

Example

                    'The following example uses the SetTime method to set the time on the
'"Start" calendar.
  
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup

Back to top

 

SetYear Method

Description

Sets the Year in the open calendar popup applet.

Syntax

object.SetYear (Year)

Arguments

ParameterDescription
Year Required. A long integer value.
The new year value.

Return Type

None.

Example

                    'The following example uses the SetYear method to set the date on the
'"Start" calendar.
  
my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup

Back to top

 

CalendarType Property

Description

The type of calendar.

Syntax

object.CalendarType

Value Type

A String value.

Property type

Read-only property

IMPORTANT

The value of this property must be either Date, DateTime, or DateTimeZone.

Example

                    'The following example uses the CalendarType property to confirm that the
'"Start" Calendar is a DateTimeZone calendar before setting the date, time,
'and time zone on the calendar.

my_year = Year(Now)
my_month = Month(Now)
my_day = Day(Now)
my_time = Hour(Now) & Minute(Now) & Second(Now)
var_CalendarType = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").CalendarType
If var_CalendarType = "DateTimeZone" Then
    Reporter.ReportEvent 2, "SiebCalendar object of DateTimeZone type. ", "Following are possible actions on this object. "
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").OpenPopup
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetYear my_year
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetMonth my_month
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetDay my_day
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetTime my_time
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup
 End If

Back to top

 

ClassName Property

Description

The class of the object.

Syntax

object.ClassName

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the UIName and ClassName properties to display this
'information for all child objects of the Siebel Call Center application.

'Retrieve all the children of the siebel application object
Set MyDescription = Description.Create()
Set MyChildren = SiebApplication("Siebel Call Center").ChildObjects(MyDescription)
childCount = MyChildren.Count
'Display the UI names and classes for each object.
For i = 0 To childCount - 1
    MsgBox MyChildren(i).UIName + "  object of class   " + MyChildren(i).ClassName
Next

Back to top

 

Day Property

Description

The current day in the open calendar control.

Syntax

object.Day

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the Day method to retrieve compare the
'calendar's date setting with the relevant portion of the text displayed
'in the "Start" calendar object.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
var_Time = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Time
var_Month = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
var_Day = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Day
var_Year = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Year
If (Trim(var_Text) = Trim(var_Month) & "/" & Trim(var_Day) & "/" & Trim(var_Year) & Trim(var_Time)) Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", " The expected date and time were  found. "
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", " The date and time displayed in the calendar do not match expected values. "
End If

Back to top

 

IsEnabled Property

Description

Indicates whether the object is enabled.

Syntax

object.IsEnabled

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsEnabled method to ensure that a calendar
'control is enabled before entering a text value.

var_IsEnabled = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").IsEnabled
If var_IsEnabled Then
    SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").SetText Trim(Date)
End If

Back to top

 

IsOpen Property

Description

Indicates whether the associated popup applet is open.

Syntax

object.IsOpen

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsOpen property to check whether the
'"Close Date" calendar pop-up object is already open, and if not, opens it.

var_IsOpen = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").IsOpen
If Not var_IsOpen Then
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Opportunity").SiebCalendar("Close Date").OpenPopup
End If

Back to top

 

IsRequired Property

Description

Indicates whether the object is required.

Syntax

object.IsRequired

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the IsRequired property to check whether the
'"Start" calendar is set as a required field and then attempts to enter
'an empty string in it. The example then confirms that a warning message
'opens when submitting an empty string in the required field.

var_IsRequired = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").IsRequired
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SetText ""
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebButton("New").Click
var_Exist = Browser("Siebel Call Center").Dialog("Siebel").Exist
If (var_IsRequired And var_Exist) Then
    Reporter.ReportEvent 0, "SiebCalendar object   ", "behaves as expected for a required field."
Else
   Reporter.ReportEvent 1, "SiebCalendar object   ", "does not behave properly as a required field."
End If
Browser("Siebel Call Center").Dialog("Siebel").WinButton("OK").Click

Back to top

 

Month Property

Description

The current month in the open calendar control.

Syntax

object.Month

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the Month method to retrieve compare the
'calendar's month setting with the relevant portion of the text displayed
'in the "Start" calendar object.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
var_Time = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Time
var_Month = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
var_Day = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Day
var_Year = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Year
If (Trim(var_Text) = Trim(var_Month) & "/" & Trim(var_Day) & "/" & Trim(var_Year) & Trim(var_Time)) Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", " The expected date and time were  found. "
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", " The date and time displayed in the calendar do not match expected values. "
End If

Back to top

 

RepositoryName Property

Description

The name of the object as it is stored in the repository.

Syntax

object.RepositoryName

Value Type

A String value.

Property type

Read-only property

Back to top

 

Text Property

Description

The text value of the object.

Syntax

object.Text

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the Text method to retrieve the complete text
'of the "Start" calendar object in order to confirm that it contains the
'expected date and time elements.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
var_Time = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Time
var_Month = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
var_Day = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Day
var_Year = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Year
If (Trim(var_Text) = Trim(var_Month) & "/" & Trim(var_Day) & "/" & Trim(var_Year) & Trim(var_Time)) Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", " The expected date and time were  found. "
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", " The date and time displayed in the calendar do not match expected values. "
End If

Back to top

 

Time Property

Description

The current time in the open calendar control.

Syntax

object.Time

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the Time method to retrieve compare the
'calendar's time setting with the relevant portion of the text displayed
'in the "Start" calendar object.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
var_Time = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Time
var_Month = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
var_Day = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Day
var_Year = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Year
If (Trim(var_Text) = Trim(var_Month) & "/" & Trim(var_Day) & "/" & Trim(var_Year) & Trim(var_Time)) Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", " The expected date and time were  found. "
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", " The date and time displayed in the calendar do not match expected values. "
End If

Back to top

 

TimeZone Property

Description

The current time zone in the open calendar control.

Syntax

object.TimeZone

Value Type

A String value.

Property type

Read-only property

Example

                    ' The following example uses the TimeZone property to confirm that the
' selected time zone is correct.

SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").SelectTimeZone "(GMT-07:00) Mountain Time (US & Canada)"
SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").ClosePopup
var_TimeZone = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").TimeZone
If Right(var_TimeZone, 13) = "(US & Canada)" Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", "Expected TimeZone was found."
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", "Unexpected TimeZone was found."
End If

Back to top

 

TimeZoneCount Property

Description

The number of time zones in the time zone picklist for the open calendar control.

Syntax

object.TimeZoneCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the TimeZoneCount property to record the number
'of time zones available in the time zone list.

var_TimeZoneCount = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").TimeZoneCount
Reporter.ReportEvent 2, "The SiebCalendar object ", "Contains " & var_TimeZoneCount & "  time zones in the list."

Back to top

 

UIName Property

Description

The name of the object as it is appears in the user interface.

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example finds all the objects in the Daily Calendar with the same
'classname as a specified SiebPickList object and then displays the Repository
'name of each of these objects.

Set MyDescription = Description.Create()
MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName
Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription)
childCount = MyChildren.Count
' now we show test object names
For i = 0 To childCount - 1
        MsgBox MyChildren(i).RepositoryName
Next

Back to top

 

Year Property

Description

The current year in the open calendar control.

Syntax

object.Year

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example uses the Year method to retrieve compare the
'calendar's year setting with the relevant portion of the text displayed
'in the "Start" calendar object.

var_Text = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Text
var_Time = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Time
var_Month = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Month
var_Day = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Day
var_Year = SiebApplication("Siebel Call Center").SiebScreen("Opportunities").SiebView("Opportunity Activities").SiebApplet("Activities").SiebList("List").SiebCalendar("Start").Year
If (Trim(var_Text) = Trim(var_Month) & "/" & Trim(var_Day) & "/" & Trim(var_Year) & Trim(var_Time)) Then
    Reporter.ReportEvent 0, "SiebCalendar object.  ", " The expected date and time were  found. "
Else
    Reporter.ReportEvent 1, "SiebCalendar object.  ", " The date and time displayed in the calendar do not match expected values. "
End If

Back to top

See also: