Shared libraries
SignifyTypeExtensions
- This library is used to to type casting for primitive types and has built-in error checking while performing type casting.
- This type casting is extended from String, DataTable and Object types.
- Examples:
var dateVariable = dt.ToDateTime(0, "ExpiredBeforeDate"); // extends DataTable type
var boolVariable = dt.ToBoolean(0, "ViewAssessmentTranscript");
var stringVariable = dt.ToString(0, "DocumentReferenceNumber");
var decimalVariable = this.ToDecimal();
var intVariable = this.ToInt32();
var doubleVariable = this.ToDouble();
var floatVariable = this.ToFloat();
TODO: Add example method for each type
SignifyControlLibrary
- This library extends certain controls inheriting from System.Web.UI.WebControls that are used regularly on web forms.
- Some properties are added to these controls that automate some of the functions that are normally performed on this control.
- Controls that are extended are
<asp:Repeater>
<asp:HiddenField>
<asp:TextBox>
<asp:Literal>
<asp:DropDownList>
- Examples:
<!--
AllowPaging - switch paging on or off for repeater
PageSize
public enum PageSizes
{
Ten = 10,
Twenty = 20,
Fifty = 50,
Hundred = 100
}
NoResultsFoundMessage - override no results message
-->
<signify:SignifyRepeater ID="rptOverlapHistories" runat="server" AllowPaging="false" NoResultsFoundMessage="No results found for your search criteria.">
<!--
Visible is by default false
-->
<signify:SignifyHiddenField ID="hfProcessObjectID" runat="server" Value="0" />
<!--
DisplayType
public enum DisplayTypes
{
TextBox,
TextArea,
SearchBox
}
protected override void OnPreRender(EventArgs e)
{
base.OnPreRender(e);
switch (_displayType)
{
case DisplayTypes.TextBox:
this.TextMode = TextBoxMode.SingleLine;
if (this.MaxLength == 0)
this.MaxLength = 500;
break;
case DisplayTypes.TextArea:
this.TextMode = TextBoxMode.MultiLine;
if (this.MaxLength == 0)
this.MaxLength = 2000;
break;
case DisplayTypes.SearchBox:
this.TextMode = TextBoxMode.SingleLine;
if (this.MaxLength == 0)
this.MaxLength = 200;
break;
default:
break;
}
}
-->
<signify:SignifyTextBox MaxLength="50" ID="txtEmpNo" runat="server" DisplayType="SearchBox" Width="170px"></cc:SignifyTextBox>
<!--
FormatDate - true/false (Should the text be Formatted to yyyy/mm/dd before rendering to the client?)
UseSession_DateFormat
EncodeHTML - true/false (Should the text be HtmlEncoded before rendering to the client?)
-->
<signify:SignifyLiteral ID="lPreferred" runat="server" Text="Preferred"></signify:SignifyLiteral>
<!--
Text - places i image before text in page heading
-->
<signify:SignifyPageDescription ID="pdOptMsg" runat="server" Text="When selected, steps in the pathway are copied but empty.<br>Each step must be configured e.g. for the Document step a document needs to be uploaded.<br>When not selected, a copy of the pathway structure is also made e.g. for a Document step, the document will already be available for download"></signify:SignifyPageDescription>
<!--
AddAllOption - Add an extra option named \"All\" to drop down list and returns a \"%\" in the value property, this properties can be changed
AllOptionText - Sets the text property for the \"All\" option
AllOptionValue - Sets the value property for the \"All\" option"
-->
<signify:SignifyDropDownList ID="ddlAppType" runat="server" AddAllOption="true" AllOptionText="" AllOptionValue="" DataValueField="ObjectID" />
TODO: Single example per control, state what the defaults are
SignifyHR.Helpers
- Groups commonly used helpers used across all modules in Signify
Helpers available:
- ApiUtilities
- BooleanHelper
- CalendarControlHelper
- DateHelper
- DocumentUploadHelper
- EnumHelper
- ExceptionHelper
- FileHelper
- FunctionHelper
- GenerateTokenUtilities
- HorizontalCalendarControlHelper
- HttpExceptionHelper
- HttpResultHelper
- ImageUtilities
- IntegerHelper
- JsonCallHelper
- ModelHelper
- MvcUtilities
- NetworkHelper
- NetworkUitlities
- OrderHelper
- RoleUtilities
- ScormHelper
- SessionHelper
- SignifyHtmlUtilities
- SmsHelper
- StringHelper
- SvgHelper
- SystemStandards
- TransactionLogger
- XmlCallHelper
- VerticalCalendarControlHelper
TODO - description of helper and signature of 3 methods
Third-Party Integrations
SigniFlowUtilities
AdobeUtilities
QuestionMark
Rustici
ZoomConnect