Holiday Sale!

It's that time of year again! A time for family, friends and general merriment! As our gift to you, save 20% on the first year of any GraffitiSuite subscription! Use code HOLIDAYS2024 at checkout to save!
(Valid for new and returning customers until January 2, 2025)

GraffitiModal

Home
Docs
Desktop
Desktop Modal
GraffitiModal

Table of Contents

Requirements
Previews
About
- Features
Enumerations
Constants
Events
Methods
Properties

Requirements #

This product requires GraffitiAnimator be present within your project in order to function.

Previews #

About #

GraffitiModal is a powerful modal overlay control that embeds containers within DesktopWindows and provides both an elegant and easy-to-use interface.

Features #

Show and Hide methods allow for reuse of modals
Event-driven design
Containers are created visually in the IDE
Dismiss on backdrop press
Helpful key handling built-in to GraffitiModalContainers

Enumerations #

This class exposes no enumerations.

Constants #

This class exposes no constants.

Events #

Name	Parameters	Return Type	Description
DataAvailable	modal as GraffitiModalInstance data as Dictionary	None	Raised when calling the Action method from within a GraffitiModalContainer.
Hidden	modal as GraffitiModalInstance	None	Raised when a modal instance has been hidden.
Shown	modal as GraffitiModalInstance	None	Raised when a modal instance has been shown.

Methods #

Name	Parameters	Return Type	Description
Add	modal as GraffitiModalInstance	None	Adds the specified modal instance to the parent window and completes setup required for showing the modal.
Hide	modal as GraffitiModalInstance	None	Hides the modal instance, if visible.
ModalWithName	name as String	GraffitiModalInstance	Returns the modal instance that has been added whose name property is specified as the parameter value.
Remove	modal as GraffitiModalInstance	None	Removes the specified modal and closes its representation on the window.
Resize	None	None	Forces a resize and redraw to match changed parent dimensions.
Show	modal as GraffitiModalInstance	None	Begins the animation process to show the modal instance. Modal will not be completely shown until the Shown event is fired.

Properties #

Name	Type	Default Value	Description
OverlayColor	ColorGroup	Nil	Color applied to the image of the window’s contents behind the modal. Default is a transparent black color.
Window	DesktopWindow	Nil	This property must be set upon creation of the GraffitiModal instance. If you have dragged GraffitiModal to a DesktopWindow, set this value in the Opening event of that window. If you are instantiating the class in code, set the value immediately after creating the class instance.