Loading...

Notes API

Methods
RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

disable()

Disables the widget on the form.

Example-Disable Notes

tpc.forms[0].TpcNotes.disable();
Parameters

None

Returns

None

get_type()

Returns the widget type.

Example-Notes Fetch Type

tpc.forms[0].TpcNotes.get_type();
Parameters

None

Returns

String

set_value()

Sets the value of the widget.

Example-Notes Set Value

tpc.forms[0].TpcNotes.set_value();
Parameters

None

Returns

None

enable()

Enables the widget on the form.

Example-Enable Notes

tpc.forms[0].TpcNotes.enable();
Parameters

None

Returns

None

hide()

Hides the widget from the form.

Example-Hide Notes

tpc.forms[0].TpcNotes.hide();
Parameters

None

Returns

None

readonly()

Sets the widget state to read only.

Example-Notes ReadOnly

//set to true
tpc.forms[0].TpcNotes.readonly(true);

//set to false
tpc.forms[0].TpcNotes.readonly(false);

//show the read only status
tpc.forms[0].TpcNotes.readonly();
Parameters

None

Returns

None

get_value()

Returns the value of the widget.

Example-NOTES FETCH VALUE

tpc.forms[0].TpcNotes.get_value();
Parameters

None

Returns

String

toggle()

Toggles the visibility of the widget.

Example-Notes Toggle

tpc.forms[0].TpcNotes.toggle();
Parameters

None

Returns

None

get_scrollView()

Returns the scroll view template element associated with the widget. This template is used to render a notes as a slider.

Example-Notes Fetch ScrollView Template

tpc.forms[0].TpcNotes.get_scrollView();
Parameters

None

Returns

jQuery Object

show()

Shows the widget on the form.

Example-Show Notes

tpc.forms[0].TpcNotes.show();
Parameters

None

Returns

None

get_input()

Returns the input element of the widget.     

Example-Notes Fetch Input Element

tpc.forms[0].TpcNotes.get_input();
Parameters

None

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Example-Notes Fetch Container Element

tpc.forms[0].TpcNotes.get_container();
Parameters

None

Returns

jQuery Object

get_element()

Returns the element of the widget.

Example-Notes Fetch Element

tpc.forms[0].TpcNotes.get_element();
Parameters

None

Returns

jQuery Object

get_addButton()

Returns the add button element associated with the widget.

Example-Notes Fetch Add Button

tpc.forms[0].TpcNotes.get_addButton();
Parameters

None

Returns

jQuery Object

get_editTemplate()

Returns the edit template element associated with the widget. This template is used to render a note that is about to edited and also includes a file upload input field.

Example-Notes Fetch Edit Template

tpc.forms[0].TpcNotes.get_editTemplate();
Parameters

None

Returns

jQuery Object

get_viewTemplate()

Returns the view template element associated with the widget. This template is used to render each note into HTML.

Example-Notes Fetch View Template

tpc.forms[0].TpcNotes.get_viewTemplate();
Parameters

None

Returns

jQuery Object

get_listView()

Returns the Kendo ListView Object associated with the widget.

Example-Notes Fetch List View

tpc.forms[0].TpcNotes.get_listView();
Parameters

None

Returns

Kendo Object: Kendo.ui.ListView

get_pager()

Returns the Kendo Pager Object associated with the widget.

Example-Notes Fetch Pager

tpc.forms[0].TpcNotes.get_pager();
Parameters

None

Returns

Kendo Object: Kendo.ui.Pager

get_pagerInput()

Returns the input element of the Kendo Pager Object associated with the widget.

Example-Notes Fetch Pager Input Element

tpc.forms[0].TpcNotes.get_pagerInput();
Parameters

None

Returns

jQuery Object

get_model()

Returns the model object of the widget, which contains a number of useful properties related to the widget.
In the case of the Notes widget, these returned properties and their types are:

  • AllowedExtensions: String
  • ControlDataId: String
  • CurrentRecordId: String
  • CurrentRecordLogicalName: String
  • MaxFileSizeBytes: Integer
  • NotecharacterLength: Integer
  • PageSize: Integer

Example-Notes Fetch Model

tpc.forms[0].TpcNotes.get_model();
Parameters

None

Returns

Object