- Getting Started
- Demo apps
- How To
- Build Your First App
- Build a Mobile-Friendly App
- General User Experience Guidelines
- Use Master Detail View
- Use Document Viewer
- Use Count With Choice Set Values
- Use Selected Values From a Table
- Embed Apps
- Embed Maps
- Hide Containers Using a Button
- Include MailTo Links
- Include Star Ratings
- Set External Context
- Work With Data Source and Value Bind
- Use the Send Interim Result Activity
- Public Apps
- Notifications
- Using VB Expressions
- Designing your App
- Events and Rules
- Rule: If-Then-Else
- Rule: Open a Page
- Rule: Open URL
- Rule: Close Pop-Over/Bottom Sheet
- Rule: Show Message
- Rule: Show/Hide Spinner
- Rule: Set Values
- Rule: Start Process
- Rule: Upload File to Storage Bucket
- Rule: Get File From Storage Bucket
- Rule: Reset Values
- Rule: Create/Update Entity Record
- Rule: Delete Entity Record
- Rule: Add to Queue
- Function: And, Or, Not
- Function: Concat
- Function: Contains
- Function: Count
- Function: EndsWith
- Function: If
- Function: IsBlank
- Function: Guid
- Function: Length
- Function: List
- Function: StartsWith
- Function: Sum
- Function: Sort
- Function: Now
- Function: Today
- Function: Time
- Function: Year
- Function: Month
- Function: Day
- Function: Hour
- Function: Minute
- Function: New
- Function: Lookup
- Function: Filter
- Leveraging RPA in your App
- Leveraging Entities in Your App
- Leveraging Queues in Your App
- Leveraging Media in your app
- Leveraging Actions in your app
- Leveraging Connections in your apps
- Application Lifecycle Management (ALM)
- UiPath First-Party Apps
- Basic Troubleshooting Guide
![](https://docs.uipath.com/_next/static/media/grid.05ebd128.png?w=3840&%3Bq=100)
Custom VB functions
-
Function:
String Serialize(Object value)
-
Description: Returns a string representation of the specified object.
-
Example:
Serialize(Queues.testQueue.arg1)
Serialize(Queues.testQueue.arg1)
-
Function:
T Deserialize<T>(string obj)
-
Description: Returns an object of type T. Takes as input a valid JSON string representation of an object.
-
Example:
WhereDeserialize(Of AppsFile)(textV)
Deserialize(Of AppsFile)(textV)textV
is a variable of type Tex, containing the serialized string of the object.
-
Function:
T? App.QueryParam<T>((string param, T? defaultValue = default(T))
-
Description:
-
If the query parameter is passed in the URL , the function returns that value deserialized based on generic type T.
-
If the deserialization fails or if the query parameter is not passed in the URL, then the function returns the default value.
-
-
Example:
App.QueryParam(Of AppsFile)("file", new AppsFile("https://i0.wp.com/ imagelinkmri.com/wp-content/uploads/2021/08/imagelink-04.png"))
App.QueryParam(Of AppsFile)("file", new AppsFile("https://i0.wp.com/ imagelinkmri.com/wp-content/uploads/2021/08/imagelink-04.png"))
-
Function:
string App.QueryParam(string param, string? defaultValue = "")
-
Description:
-
If the query parameter is passed in the URL, the function returns that value as string.
-
If the query parameter is not passed in the URL, the function return the default value.
-
-
Example:
App.QueryParam("stringVariable", "defaultText")
App.QueryParam("stringVariable", "defaultText")
-
Function:
List<T> AddItemToList<T>(List<T> list, T value)
-
Description: Given a list of type T, appends an item to the list and returns the updated list.
-
Example:
AddItemToList(Of String)(stringList, "AddMe")
AddItemToList(Of String)(stringList, "AddMe")
-
Function:
List<T> UpdateListItemAtIndex<T>(List<T> list, int index, T value)
-
Description: Given a list of type T, updates the item at the specified index, and returns the updated list.
-
Example:
UpdateListItemAtIndex(Of String)(stringList, MainPage.EditGrid.RowIndex,"UpdateValue")
UpdateListItemAtIndex(Of String)(stringList, MainPage.EditGrid.RowIndex,"UpdateValue")
-
Function:
List<T> DeleteItemFromList<T>(List<T> list, int index)
-
Description: Given a list of type T, deletes the item at the specified index and returns the updated list.
-
Example:
DeleteItemFromList(Of String)(stringList, MainPage.EditGrid.RowIndex)
DeleteItemFromList(Of String)(stringList, MainPage.EditGrid.RowIndex)
-
Function:
ListSource<T> Fetch<T>(FilterGroup group = null, PaginationProps paginationProps = null, SortOption[] sortOptions = null, string[] selectedFields = null, ExpansionFieldOption[] expansionFieldOptions = null )
-
Description: Returns all the records of an entity object, according to the mentioned parameters.
-
Example:
Fetch(of AlexEntity)(createFilterGroup(Nothing, New FilterGroup(){createFilterGroup(New QueryFilter(){addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)}, Nothing, 0)}, 0), New PaginationProps(MainPage.EditGrid.PageStart, MainPage.EditGrid.PageLimit), New SortOption(){addSortOption(MainPage.EditGrid.SortColumn, Not(Not(MainPage.EditGrid.isDescending)))}, Nothing, New ExpansionFieldOption(){addExpansionFieldOption("CreatedBy", New String(){"Id","Name"}), addExpansionFieldOption("UpdatedBy", New String(){"Id","Name"})})
Fetch(of AlexEntity)(createFilterGroup(Nothing, New FilterGroup(){createFilterGroup(New QueryFilter(){addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)}, Nothing, 0)}, 0), New PaginationProps(MainPage.EditGrid.PageStart, MainPage.EditGrid.PageLimit), New SortOption(){addSortOption(MainPage.EditGrid.SortColumn, Not(Not(MainPage.EditGrid.isDescending)))}, Nothing, New ExpansionFieldOption(){addExpansionFieldOption("CreatedBy", New String(){"Id","Name"}), addExpansionFieldOption("UpdatedBy", New String(){"Id","Name"})})Note:TheFetch()
function is used by the Query builder and it is asynchronous.
-
Function:
T FetchOne<T>(FilterGroup group = null, PaginationProps paginationProps = null, SortOption[] sortOptions = null, string[] selectedFields = null, ExpansionFieldOption[] expansionFieldOptions = null)
-
Description: Returns a single record of an entity object, according to the mentioned parameters.
-
Example:
FetchOne(of Employee)( createFilterGroup(new QueryFilter(){addFilter( MainPage.EditGrid.SearchColumn,"contains",MainPage.EditGrid.SearchTerm)}), new PaginationProps(MainPage.EditGrid.PageStart, MainPage.EditGrid.PageLimit), new SortOption(){ addSortOption( MainPage.EditGrid.SortColumn,MainPage.EditGrid.isDescending) } )
FetchOne(of Employee)( createFilterGroup(new QueryFilter(){addFilter( MainPage.EditGrid.SearchColumn,"contains",MainPage.EditGrid.SearchTerm)}), new PaginationProps(MainPage.EditGrid.PageStart, MainPage.EditGrid.PageLimit), new SortOption(){ addSortOption( MainPage.EditGrid.SortColumn,MainPage.EditGrid.isDescending) } )Note:TheFetchOne()
function is used by the Query builder and it is asynchronous.
-
Function:
FilterGroup createFilterGroup(QueryFilter[] queryFilters, FilterGroup[] groups = null, int isAnd = 0)
-
Description: Given an array of query filters and filter groups, generates a filter group.
-
Example:
createFilterGroup(Nothing, New FilterGroup(){createFilterGroup(New QueryFilter(){addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)}, Nothing, 0)}, 0)
createFilterGroup(Nothing, New FilterGroup(){createFilterGroup(New QueryFilter(){addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)}, Nothing, 0)}, 0)
createFilterGroup()
function is used by the Query builder.
-
Function:
QueryFilter addFilter(string columnName, string colOperator, string value)
-
Description: Given a column name, operator and value, generates a query filter.
-
Example:
addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)
addFilter(MainPage.EditGrid.SearchColumn, "contains", MainPage.EditGrid.SearchTerm)
addFilter()
function is used by the Query builder.
-
Function:
SortOption addSortOption(string columnName, bool isDescending = false)
-
Description: Given a column name and a sorting value, generates and sorts a query filter.
-
Example:
addSortOption(MainPage.EditGrid.SortColumn, Not(Not(MainPage.EditGrid.isDescending)))}
addSortOption(MainPage.EditGrid.SortColumn, Not(Not(MainPage.EditGrid.isDescending)))}
addSortOption()
function is used by the Query builder.
-
Function:
ListSource<ChoiceSet> GetChoiceSet(string choiceSetName)
-
Description: Given the name of a Data Service choice set, returns all the values in the choice set.
-
Example:
GetChoiceSet("Gender")
GetChoiceSet("Gender")
The entity hosting the choice set must be added in your app.
GetChoiceSet()
function is asynchronous.
-
Function:
string GetChoiceSetValue(string choiceSetName, int numberId)
-
Description: Given the name of a Data Service choice set and the index of a choice set option, returns the specified option.
-
Example:
GetChoiceSetValue("Gender", 0)
GetChoiceSetValue("Gender", 0)
The entity hosting the choice set must be added in your app.
-
Function:
DataTable BuildDataTable(DataTable dt, DataColumn[] columns, List<Object> rowData, bool clear=false)
-
Description: Loads a data table with columns and rows in the Set Value rule and returns the updated data table.
If theclear
parameter is true, it clears the content in the columns and the rows of the data table. -
Example:
BuildDataTable( New DataTable("TestDT"), New DataColumn(){ New DataColumn("Name"), New DataColumn("Age")}, New List(Of Object) From { AddDataRow(New Object(){"Baishali", "30"}), AddDataRow(New Object(){"Viswa", "33"}) }, True )
BuildDataTable( New DataTable("TestDT"), New DataColumn(){ New DataColumn("Name"), New DataColumn("Age")}, New List(Of Object) From { AddDataRow(New Object(){"Baishali", "30"}), AddDataRow(New Object(){"Viswa", "33"}) }, True )
-
Function:
AddRow(DataRow row)
-
Description: DataTable extension method that adds the specified row to a data table and returns the updated instance.
-
Example:
dt.AddRow(row)
dt.AddRow(row)
-
Function:
DeleteRowAt(int index)
-
Description: DataTable extension method that deletes the row at the specified index in a data table and returns the updated instance.
-
Example:
dt.DeleteRowAt(2)
dt.DeleteRowAt(2)
- Function: Serialize
- Function: Deserialize
- Function: App.QueryParam
- For objects
- For strings
- Function: Add item to list
- Function: Update list item at index
- Function: Delete item from list
- Function: Fetch
- Function: Fetch one
- Function: Create filter group
- Function: Add filter
- Function: Add sort option
- Function: Get choice set
- Function: Get choice set value
- Function: Build data table
- Function: Add row
- Function: Delete row
- Function: Update row at