Difference between revisions of "Highlight in Documentation"
(Created page with "==Scope== * '''Simulation''' project > '''Explanation''' macro > '''Documentation''' > '''Highlight in Documentation''' property ==Purpose== This property determines...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Scope== | ==Scope== | ||
| − | * '''[[Simulation]]''' | + | * '''[[Simulation]]''' content object > '''[[Explanation]]''' macro > '''Documentation''' > '''Highlight in Documentation''' property |
==Purpose== | ==Purpose== | ||
| − | This property determines whether or not a Highlight should be shown for the parent '''Explanation''' macro in the generated document. If this property is selected, then the '''[[Highlight Position / Size]]''' property must also be activated, and the Highlight must be manually positioned on the Screenshot, because there is no [[Control]] associated with an Explanation frame, on which the Highlight could otherwise initially be based. The Highlight can be positioned either by entering the position and size directly into the '''[[Highlight Position / Size]]''' property, or by dragging and/or resizing the Highlight in the [[Documentation | + | This property determines whether or not a Highlight should be shown for the parent '''Explanation''' macro in the generated document. If this property is selected, then the '''[[Highlight Position / Size]]''' property must also be activated, and the Highlight must be manually positioned on the Screenshot, because there is no [[Control]] associated with an Explanation frame, on which the Highlight could otherwise initially be based. The Highlight can be positioned either by entering the position and size directly into the '''[[Highlight Position / Size]]''' property, or by dragging and/or resizing the Highlight in the [[Documentation View]] (it will not appear in the play mode views). |
If you also want a Marker, pointing to this Highlight, to be included in the document, then the '''[[Marker orientation]]''' property must also be selected for the parent macro, and the '''[[Icon]]''' property for the parent macro must be set to '''No icon'''. | If you also want a Marker, pointing to this Highlight, to be included in the document, then the '''[[Marker orientation]]''' property must also be selected for the parent macro, and the '''[[Icon]]''' property for the parent macro must be set to '''No icon'''. | ||
Latest revision as of 06:15, 15 September 2019
Scope
- Simulation content object > Explanation macro > Documentation > Highlight in Documentation property
Purpose
This property determines whether or not a Highlight should be shown for the parent Explanation macro in the generated document. If this property is selected, then the Highlight Position / Size property must also be activated, and the Highlight must be manually positioned on the Screenshot, because there is no Control associated with an Explanation frame, on which the Highlight could otherwise initially be based. The Highlight can be positioned either by entering the position and size directly into the Highlight Position / Size property, or by dragging and/or resizing the Highlight in the Documentation View (it will not appear in the play mode views).
If you also want a Marker, pointing to this Highlight, to be included in the document, then the Marker orientation property must also be selected for the parent macro, and the Icon property for the parent macro must be set to No icon.
See Also
- Simulation project > Explanation macro > Documentation > Highlight Position / Size property
