Skip to content

Commit

Permalink
Added getProjectViewSelection()
Browse files Browse the repository at this point in the history
Added getProjectViewSelection()
  • Loading branch information
bbb999 committed Aug 6, 2021
1 parent ebe6930 commit 4f12b3f
Showing 1 changed file with 38 additions and 6 deletions.
44 changes: 38 additions & 6 deletions docs/application/application.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. highlight:: javascript

.. _Application:

Expand Down Expand Up @@ -329,7 +328,7 @@ app.projects

**Description**

An array referencing all open projects; `numProjects` contains size.
An array referencing all open projects; ``numProjects`` contains size.

**Type**

Expand Down Expand Up @@ -819,7 +818,7 @@ Argument Type Description

**Example**

Activate `Editing` workspace.
Activate ``Editing`` workspace.

.. code:: javascript
Expand Down Expand Up @@ -898,11 +897,11 @@ Returns the Project associated with the provided View ID.

**Parameters**

A View ID, obtained from `getProjectViewIDs`.
A View ID, obtained from ``getProjectViewIDs``.

**Returns**

A Project object, for the project associated with the provided View ID. Can be `null`.
A Project object, for the project associated with the provided View ID. Can be ``null``.

**Example**

Expand All @@ -920,4 +919,37 @@ A Project object, for the project associated with the provided View ID. Can be `
}
} else {
// No views open.
}
}
----
.. _app.getProjectViewSelection:
app.getProjectViewSelection()
*********************************************
``app.getProjectViewSelection()``
**Description**
Returns an array of projectItems selected, in the current active project view.
**Parameters**
None.
**Returns**
An array of projectItems; can be null.
**Example**
.. code:: javascript
var selectedItems = app.getProjectViewSelection();
if (selectedItems){
var firstOne = selectedItems[0];
} else {
// No projectItems selected.
}

0 comments on commit 4f12b3f

Please sign in to comment.