Cookie

The Cookie component gets, sets, and deletes cookies, which is data held on the user's computer, placed there by the site. This information can be used for such things as user preferences when a user visits a site frequently.

NOTE: This component has been optimized for usage with 4.x+ browsers only

Properties

name

Description - (REQUIRED) Enter unique name of the control. Must exactly match the name of the corresponding JavaScript object on the page.
Type - STRING
DefaultValue - CookieComponent1

cookieName

Description - Enter the name of the cookie that you wish to manipulate.
Type - STRING

value

Description - Enter the value that you wish to put into the cookie.
Type - STRING

year

Description - Enter the expiration year after which the cookie to no longer be valid.
Type - INTEGER
DefaultValue - 1999

month

Description - Enter the expiration month after which the cookie to no longer be valid.
Type - INTEGER
DefaultValue - 9

day

Description - Enter the expiration day after which the cookie to no longer be valid.
Type - INTEGER
DefaultValue - 30

path

Description - Enter the path that this cookie will be valid within.
Type - STRING

domain

Description - Enter the domain that this cookie will only be valid within.
Type - STRING
DefaultValue - Thu, 01-Oct-99 00:00:01 GMT

secure

Description - Enter whether or not this cookie will utilize SSL to get/put the cookie data.
Type - BOOLEAN
DefaultValue - No


Methods

void setCookie( name )

Function:setCookie
Input:String - name of the component being used
Return:None
Description:This method will set the cookie with the value specified within the properties or set by the setcookieName method.


string getCookie( name )

Function:getCookie
Input:String - name of the component being used
Return:String
Description:This method will get the value held with the cookie and return it to the calling function.


boolean deleteCookie( name )

Function:deleteCookie
Input:String - name of the component being used
Return:Boolean
Description:This method will delete the cookie held within this component.


void setcookieName(newCookie, name)

Function:setcookieName
Input:String - new value of to be set within the cookie
String - name of the component being used
Return:None
Description:This method will set the value that is attached to this cookie object.


Events

None.

Other Information

Environment: Client