Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
ardiscript:removeimage [2018/04/27 03:57] optrix created |
ardiscript:removeimage [2019/02/20 01:11] (current) optrix [See Also] |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ====Summary==== | ====Summary==== | ||
| - | This function allows you to remove | + | This function allows you to remove and image from the user interface using the name specified by a parameter from the [[addimage]] function. |
| + | |||
| + | ====Parameters==== | ||
| + | |||
| + | ===Name=== | ||
| + | |||
| + | //Type: Text | ||
| + | Default: None// | ||
| + | |||
| + | The name of the image you wish to remove. This should be the same name that was specified by the [[addimage]] function. | ||
| + | |||
| + | ====See Also==== | ||
| + | [[addimage]] [[viewmedia]] | ||
| + | |||
| + | ====Examples==== | ||
| + | |||
| + | <code> | ||
| + | <addimage Image="House.png" Name="House" /> | ||
| + | <addimage Image="Sunset.png" Name="Sunset" CanBeMoved="False" CanBeClosed="False" /> | ||
| + | </code> | ||
| + | |||
| + | > This code adds 2 images to the screen, **House.png** named **House** and **Sunset.png** named **Sunset**. | ||
| + | > The user will be able to click and drag the **House** image to move it around the screen and position as they see fit. They can also click on the cross icon at the top right of it to remove it. The **Sunset** image however will be unable to be moved or removed. | ||
| + | |||
| + | <code> | ||
| + | <removeimage Name="Sunset" /> | ||
| + | </code> | ||
| + | |||
| + | > This code will search for the image named **Sunset** as defined by the //Name// parameter. It will then remove it from the user interface. | ||