This interface is deprecated.
Beginning July 1st, 2017, any new channels using this component will be rejected during certification.
Beginning January 1st, 2018, any updates to existing channels using this component will be rejected during certification.
- SetTitle(title as String) as Void
- AddHeaderText(text as String) as Void
- AddParagraph(text as String) as Void
- AddButton(id as Integer, title as String) as Boolean
- AddFocalText(text as String, spacingFormat as String) as Void
- Void SetBreadcrumbText(String location1, String location2)
- SetRegistrationCode(regCode as String) as Void
- Show() as Boolean
- Close() as Void
Description of Methods
SetTitle(title as String) as Void
Set the title for the screen to the specified string.
AddHeaderText(text as String) as Void
Add a string of bold, high visibility text to the screen as a header to introduce the subsequent paragraph(s).
AddParagraph(text as String) as Void
Adds a paragraph of text to the screen. A paragraph is specified as a single string and are ordered on the screen in the same order as they are added. The roCodeRegistrationScreen handles all text formatting and justification. Spacing is automatically inserted between paragraphs for readability.
AddButton(id as Integer, title as String) as Boolean
Adds a button to the screen identified by the title and ID provided. The buttons are at the bottom of the screen and appear in the order added. When the button is pressed, the script will receive an event from the application indicating the ID of the button pressed.
AddFocalText(text as String, spacingFormat as String) as Void
Adds high visibility focal text to the screen to be placed above the registration code. This text is intended to provide the user important instructions on where to use the registration code. It is generally a few words of instruction followed by the URL for the registration site on the web. Multiple lines of text may be added and the spacing between each is controlled by specifying the spacing format as one of the following: spacing-dense, spacing–normal or spacing-sparse.
Void SetBreadcrumbText(String location1, String location2)
Breadcrumbs allow the application to display a two-part navigational title which shows the current and the previous locations in the application hierarchy (e.g. TV – Friends). If both location values are set, the application will display the title in breadcrumb format. If only the first location is set, the application will display the specified text in the title area like the SetTitle API call.
SetRegistrationCode(regCode as String) as Void
Set the registration code (e.g. XM3RT) or text (e.g. retrieving…) to be displayed on the screen.
Show() as Boolean
Display or refresh the screen after creation or state changes.
Close() as Void
Close the screen and delete the associated object. Useful for avoiding screen flicker when the display order of your screens does not resemble a stack.