Bad docs in .ui.getAncestor

Neil Kolban

May 21, 2016 at 2:44 pm #1836

Small stuff, the docs for <view>.ui.getAncestor() has an example that reads:
<pre class=”prettyprint”><span class="typ">ChildView1</span><span class="pun">.</span><span class="pln">ui</span><span class="pun">.</span><span class="pln">getAncestor</span><span class="pun">(</span><span class="str">"AncestorView1"</span><span class="pun">);</span> <span class="com">//Returns reference to the ancestor named OtherView1

</span>I believe this should be:

<pre class=”prettyprint”><span class="typ">ChildView1</span><span class="pun">.</span><span class="pln">ui</span><span class="pun">.</span><span class="pln">getAncestor</span><span class="pun">(</span><span class="str">"AncestorView1"</span><span class="pun">);</span> <span class="com">//Returns reference to the ancestor named AncestorView1</span>

Rackley Boren

May 22, 2016 at 10:00 pm #1846

Neil,

I agree. Looks like the example might have been updated for clarity without updating what the result would be. I will let the team know.

 

Regards,

Rackley Boren

Neil Kolban

May 23, 2016 at 8:07 am #1856

Thanks Rackley,

My goodness!!!   When I posted the original post, it looked fine when I posted it … however now it looks awful what with all the HTML formatting and stuff.  I don’t think I can see an option that allows me to edit a previous post either.

Any thoughts on enabling more features or using a “better” forum package?

Rackley Boren

May 23, 2016 at 9:54 am #1859

Hi Neil,

I took a note down to look into why it is stripping HTML out for users. I believe it is a setting, but will have to ask.

 

Regards,

Rackley Boren

 

jmac

May 23, 2016 at 10:01 am #1861

Doc will be updated in an upcoming release:  it will look something like this:

/**
* @method getAncestor
* @memberof bpmext.ui.View
* @instance
* @param {string} name Return a control in the ancestor chain of this control matching the name specified
* @param {boolean} literal Searches the literal ancestor(s) (which may be a visual-only section) of this control
* @desc Retrieve ancestor view
* @returns {bpmext.ui.View} The reference to the ancestor or undefined if no ancestor exists
* @example ChildView1.ui.getAncestor(“AncestorView1”); //Returns reference to the ancestor named AncestorView1
*/