helper functions in UX

[Steve Wood]

Can I get some pointers on using these helper functions in a UX component? As a simple example, I am trying to set the color of the text in a control by clicking a button.

https://www.alphasoftware.com/docume...20function.xml

For instance, this example from the documentation does not appear to work in a UX component:

/*Set the control's font family and font weight.*/
$ss('firstname',{fontFamily: 'arial', fontWeight: 'bold'});

/*The above example is a shortcut for this technique for setting the in-line style.*/
var ele = $('firstname');
ele.style.fontFamily = 'arial';
ele.style.fontWeight = 'bold';

[jgrannis]

Re: helper functions in UX

It worked for me. Except that I used it directly in the DevTools console with my mobile app connected for debugging and entered:

$ss('DLG1.V.R1.STATICTEXT_122',{fontFamily: 'arial', fontWeight: 'bold'});

I saw the text immediately change style on the device.

[Steve Wood]

Re: helper functions in UX

Thanks. I notified the document admin to update the docs for this page:https://www.alphasoftware.com/docume...ions/index.xml

I bet the helper functions are supposed to work on a UX but are not, at least in my attempt.

[RichCPT]

Re: helper functions in UX

Steve,
Yes, the documentation should be fixed to reflect how to use those helper functions in Grids and UX's. Maybe they used to work as documented, but they sure do not now.

Those 'helper' functions that begin with a "$" do not modify their first argument - the identifier of the control(s) to be modified.

1) The identifier must be in the proper case - typically always uppercase.
2) To locate the element by it's HTML "id" attribute the passed identifier must include the current alias for the UX/Grid and a row/instance number, or
3) To locate the element by its HTML "name" attribute in a UX, you typically must prefix it with "V.R1." -- using the name attribute is not recommended, as there could be other UX's using the same "name" in its controls.

[Sarah Mitchell]

Re: helper functions in UX

Thanks. I notified the document admin to update the docs for this page:https://www.alphasoftware.com/docume...ions/index.xml

I bet the helper functions are supposed to work on a UX but are not, at least in my attempt.

Hello Steve,

The Core Library functions work directly on HTML elements in the document. They will work with the UX and Grid, however you will need to build the full HTML id for those controls yourself or use the {dialog.object}.getPointer() method to get a pointer to the element (which can be used with core library functions.)

In general, you should prefer to use the {dialog.object} methods to manipulate controls in a component and not the core library functions as the built-in {dialog.object} methods will trigger events and update component state while the core library functions do not.

I do not believe there is a component equivalent for setting styles on an element, so in the case of $ss(), you can use {dialog.object}.getPointer() to get the element and pass it as the first parameter.

We have added additional information to the Core library documentation about using the functions with components. You can see it here: https://www.alphasoftware.com/docume...n%20components