Skip to content

Commit

Permalink
Merge pull request #120 from mirzakobasevic/master
Browse files Browse the repository at this point in the history
Documentation for InfoCard and AnnouncementCard PCFs
  • Loading branch information
honzakostejn authored Aug 26, 2024
2 parents 86da240 + 6879d93 commit 1abd2bf
Show file tree
Hide file tree
Showing 6 changed files with 159 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ module.exports = config({
['/en/developer-guide/applications/controls/general.md', 'General Information'],
['/en/developer-guide/applications/controls/addresspicker.md', 'Address Picker'],
['/en/developer-guide/applications/controls/annotations.md', 'Annotations'],
['/en/developer-guide/applications/controls/announcementcard.md', 'Accouncement Card'],
['/en/developer-guide/applications/controls/attachmentsgrid.md', 'Attachments Grid'],
['/en/developer-guide/applications/controls/codeeditor.md', 'Code Editor'],
['/en/developer-guide/applications/controls/colorfuloptionset.md', 'Colorful Optionset'],
Expand All @@ -387,6 +388,7 @@ module.exports = config({
['/en/developer-guide/applications/controls/FileExplorer/fileexplorer.md', 'File Explorer'],
['/en/developer-guide/applications/controls/formbutton.md', 'Form Button'],
['/en/developer-guide/applications/controls/htmlcontentdisplay.md', 'HTML Content Display'],
['/en/developer-guide/applications/controls/infocard.md', 'Info Card'],
['/en/developer-guide/applications/controls/keyfigures.md', 'Key Figures'],
['/en/developer-guide/applications/controls/mappicker.md', 'Map Picker'],
['/en/developer-guide/applications/controls/milestones.md', 'Milestones'],
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 82 additions & 0 deletions src/en/developer-guide/applications/controls/announcementcard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
Author: Mirza Kobasevic
---
# Announcement Card

This control serves to display basic information in the form of a card.

<img src='/.attachments/applications/controls/announcementcard.png' />


Bindings

<table>
<thead>
<tr>
<th>Property Name</th>
<th>Description</th>
<th>Of Type</th>
<th>Input</th>
<th>Usage</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>bindingField</td>
<td>Binding field.</td>
<td><code>SingleLine.Text</code></td>
<td></td>
<td><code>bound</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td>heading</td>
<td>Card Heading.</td>
<td><code>SingleLine.Text</code></td>
<td><code>Order</code></td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>iconName</td>
<td>JSON object that contains Webresource name or icon name from FluentUI.</td>
<td><code>SingleLine.Text</code></td>
<td>
<p><code>{ "fluentUiIconName": "LineChart" }</code></p>
<p><code>{ "webResourceName": "talxis_infoicon.svg" }</code></p>
</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>description</td>
<td>Card Description.</td>
<td><code>SingleLine.Text</code></td>
<td></td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>actionLink</td>
<td>Action link at the bottom of the card. Url without the domain.</td>
<td><code>SingleLine.Text</code></td>
<td>
<p><code>talxis_start/control/view?data={"entityName":"account","viewId":"{d71d546b-bc42-405b-9238-18792757aab1}"}</code></p>
<p><code>main.aspx?appid=07bc5f7b-b043-ef11-bfe2-6045bd9fcae8&pagetype=entitylist&viewid={d71d546b-bc42-405b-9238-18792757aab1}&etn=account</code></p>
</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>actionLinkText</td>
<td>Label for Action Link.</td>
<td><code>SingleLine.Text</code></td>
<td><code>LINK</code></td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>


75 changes: 75 additions & 0 deletions src/en/developer-guide/applications/controls/infocard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
Author: Mirza Kobasevic
---
# Info Card

This control displays basic contact/account information in the form of a card. If control is bound for SingleLine.Text, it displays information of the current user/account. By binding the control to the lookup field, it is possible to display the information of any contact/account.


<img src='/.attachments/applications/controls/InfoCard/accountinfocard.png' height='300px' />
<img src='/.attachments/applications/controls/InfoCard/contactinfocard.png' height='300px' />

# Bindings

<table>
<thead>
<tr>
<th>Property Name</th>
<th>Description</th>
<th>Of Type</th>
<th>Input</th>
<th>Usage</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>bindingField</td>
<td>Binding field.</td>
<td>
<p><code>SingleLine.Text</code></p>
<p><code>Lookup.Simple</code></p>
</td>
<td></td>
<td><code>bound</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td>mode</td>
<td>Mode decides what the card will display (account, contact)</td>
<td><code>Enum</code></td>
<td>
<p><code>contact</code></p>
<p><code>account</code></p>
</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>fetchXml</td>
<td>FetchXML Query for filtering and displaying attributes.</td>
<td><code>SingleLine.Text</code></td>
<td><pre><code>&lt;fetch version="1.0" mapping="logical"&gt;
&lt;entity name="contact"&gt;
&lt;attribute name="emailaddress1" /&gt;
&lt;attribute name="emailaddress2" /&gt;
&lt;attribute name="mobilephone" /&gt;
&lt;/entity&gt;
&lt;/fetch&gt;</code></pre>
</td>
<td><code>input</code></td>
<td><code>false</code>
</td>
</tr>
<tr>
<td>actionLink</td>
<td>Link for contact/account profile editing.</td>
<td><code>SingleLine.Text</code></td>
<td></td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>


0 comments on commit 1abd2bf

Please sign in to comment.