Scripting API

API

add_depend_item(int64, int64)

Description

This function allow the user to set dependencies to an item

Syntax

add_depend_item(item_id, ditem_id) 
add_depend_item(int64, int64)

Parameters

itemid,  
ditem_id

Pre-requisites

Return Values

Example

for inc1 = 2,MaxNumber do
add_depend_item(NumberItems[inc1],NumberItems[1])
end

  • this loop will cycle through a selected list of items and make the last item dependent on all the prior selected items

add_folder_to_notepad()

Syntax

add_folder_to_notepad(int64, int64)  add_folder_to_notepad(folder, notepad)

Description

Adds a folder to a notepad.   You can use FolderName or FolderID or the NotepadName or NotepadID.

Parameters

The cursor remains at the item where the command was issued, it is not repositioned. 

Pre-requisites

Return Values

None

Example

This code snipet gets teh current notepad id and displays its value then adds the 'Rules' folder to the end of the notepad    add_folder_to_notepad(folder_id(folder_name), notepad_id(notepad_name))    x=get_current_notepad_id() +  add_folder_to_notepad('Rules',x) 

create_folder()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

create_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

create_sub_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

debug()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

display()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_advance_warning_days()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_alarm_folder_id()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_alarm_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_contain_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_current_calendar_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_cur_filename()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_current_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_current_notepad_id()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_depend_items()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_id()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_item_count()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_items()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_name()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_recurring_type()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_rule()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_type()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_folder_value()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_children()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_index()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_parent()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_recurring_type()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_text()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_item_type()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_max_itemid()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_next_recurring_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_prev_recurring_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_select_items()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_sub_folders()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_tickler_color()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

get_tli_items()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

has_contain_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

has_depend_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

is_item_show_in_tickler()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

is_valid_itemid(item_id)

Syntax

Description

Parameters

Pre-requisites

Return Values

None

item_id

Syntax

Description

Parameters

Pre-requisites

Return Values

None

lock_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

msgbox()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

remove_depend_item()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

remove_folder_from_notepad()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_advance_warning_days()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_current_calendar_date()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_folder_rule()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_folder_value()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_item_show_in_ticker()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_item_text()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_result()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

set_tickler_color()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

trigger_rule()

Syntax

Description

Parameters

Pre-requisites

Return Values

None

unlock_item(int64)

Syntax

Unlock_item(int64)

Description

Both lock and unlock comes here. unlock(); unlock_item(item_id)

Parameters

ItemID

Pre-requisites

unlock an item that was previously locked., unlocks the item having (itemid)

Return Values

None