Loading...

Notes

Properties API Related

Widget Type:
Form Widgets
TPC Version:
  • 4.0
notelogo
The Notes Widget allows you create, update, view, and delete notes for any entity in CRM. Each note contains a title, body and an optional file attachment. 

This widget only works with a retrieved record (Form configured to an Entity).

Configuration

Basic

Make sure you have a Form with Form Configuration and a TPC Form Layout already attached.

Drag and drop the Notes Widget from the Portal Connector widget list into the body of your form and click edit to display the properties prompt.

The Title will allow you to set the label for the control.

The Basic settings contains checkboxes allowing you to determine if a user is allowed to create, edit or delete any notes for a record. There are also Allow Uploading and Downloading Attachment options.
notes-instruction-1

Appearance

The Notes Per Page numeric textfield allows you to specify how many notes that will appear on a page. If there are more notes than the allowed amount, they will be organized onto a separate page.

A pager would show if this number is larger than existing number of annotations.
notes-instruction-2

Validation

The Allowed Extensions textfield allows you to specify which files are allowed to be uploaded to a note. Each file extension type should be separated with a semicolon.

 For example, this is the value set by default:

".doc;.docx;.txt;.rtf;.pdf;.zip;.rar;.png;.jpg;.bmp;.jpeg".

notes-instruction-3

Widget Properties

Basic Properties

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Creating Notes

The Allow Creating Notes checkbox allows the user to add a note about a particular, retrieved record.

Allow Editing Notes

The Allow Editing Notes checkbox allows the user to edit existing notes about a particular record.

Allow Deleting Notes

The Allow Deleting Notes checkbox allows the user to delete an existing note about a particular record.

Allow Downloading Attachments

The Allow Downloading Attachments checkbox will allow users to download attachments.

Allow Uploading Attachments

The Allow Uploading Attachments checkbox will allow users to add attachments to a widget in the form of a file upload.

Notes Per Page

The Notes Per Page property allows you to specify how many notes will appear. If there are more notes than this number, they will be organized into separate pages.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

NoteCharacterLength

The NoteCharacterLength advanced property determines how many characters are allowed in a note. By default this is set to 384. Please note that the maximum length of the description field on the notes entity is 100,000.

HidePrefix

The HidePrefix advanced property determines whether the prefix of a note should be hidden or not. By default this is set to false.

IncludePrefix

The IncludePrefix advanced property determines if the prefix of a note should be visible or not. By default this is set to false.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Title

The Title text box will allow you to set the label of your widget. The title will usually appear above the associated widget.

Allow Creating Notes

The Allow Creating Notes checkbox allows the user to add a note about a particular, retrieved record.

Allow Editing Notes

The Allow Editing Notes checkbox allows the user to edit existing notes about a particular record.

Allow Deleting Notes

The Allow Deleting Notes checkbox allows the user to delete an existing note about a particular record.

Allow Downloading Attachments

The Allow Downloading Attachments checkbox will allow users to download attachments.

Allow Uploading Attachments

The Allow Uploading Attachments checkbox will allow users to add attachments to a widget in the form of a file upload.

Notes Per Page

The Notes Per Page property allows you to specify how many notes will appear. If there are more notes than this number, they will be organized into separate pages.

Allowed Extensions

The Allowed Extensions text box will only allow specific file types to be uploaded to a widget. Extensions are separated by a semicolon (.doc;.txt;.jpg;.png).

Hidden

The Hidden checkbox will hide the widget from the page when checked.

Tool Tip

The Tool Tip allows you to add a description or Hint to your widget.

ToolTipPosition

This property determines the position of the tool tip. By default this property is set to "Auto". You can change this to Left , Right , Top , Bottom. 

NoteCharacterLength

The NoteCharacterLength advanced property determines how many characters are allowed in a note. By default this is set to 384. Please note that the maximum length of the description field on the notes entity is 100,000.

HidePrefix

The HidePrefix advanced property determines whether the prefix of a note should be hidden or not. By default this is set to false.

IncludePrefix

The IncludePrefix advanced property determines if the prefix of a note should be visible or not. By default this is set to false.

EncryptGuids

The EncryptGuids advanced properties determines whether Guids should be encrypted or not. By default this is set to true.

LabelPosition

The LabelPosition advanced property specifies where the label of a widget will appear. By default, the label will appear on top of the widget. Applicable options include: Top and left. The content of the label is controlled by the Title property. The default value for this is 'Top'.

API

disable()

Disables the widget on the form.

Returns

None

get_type()

Returns the widget type.

Returns

String

set_value()

Sets the value of the widget.

Returns

None

enable()

Enables the widget on the form.

Returns

None

hide()

Hides the widget from the form.

Returns

None

readonly()

Sets the widget state to read only.

Returns

None

get_value()

Returns the value of the widget.

Returns

String

toggle()

Toggles the visibility of the widget.

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.

Returns

jQuery Object

show()

Shows the widget on the form.

Returns

None

get_input()

Returns the input element of the widget.     

Returns

jQuery Object

get_container()

Returns the container element of the widget.

Returns

jQuery Object

get_element()

Returns the element of the widget.

Returns

jQuery Object

get_addButton()

Returns the add button element associated with the widget.

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.

Returns

jQuery Object

get_viewTemplate()

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

Returns

jQuery Object

get_listView()

Returns the Kendo ListView Object associated with the widget.

Returns

Kendo Object: Kendo.ui.ListView

get_pager()

Returns the Kendo Pager Object associated with the widget.

Returns

Kendo Object: Kendo.ui.Pager

get_pagerInput()

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

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

Returns

Object

Full API With Examples