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 #

NameParametersReturn TypeDescription
DataAvailablemodal as GraffitiModalInstance

data as Dictionary
NoneRaised when calling the Action method from within a GraffitiModalContainer.
Hiddenmodal as GraffitiModalInstanceNoneRaised when a modal instance has been hidden.
Shownmodal as GraffitiModalInstanceNoneRaised when a modal instance has been shown.

Methods #

NameParametersReturn TypeDescription
Addmodal as GraffitiModalInstanceNoneAdds the specified modal instance to the parent window and completes setup required for showing the modal.
Hidemodal as GraffitiModalInstanceNoneHides the modal instance, if visible.
ModalWithNamename as StringGraffitiModalInstanceReturns the modal instance that has been added whose name property is specified as the parameter value.
Removemodal as GraffitiModalInstanceNoneRemoves the specified modal and closes its representation on the window.
ResizeNoneNoneForces a resize and redraw to match changed parent dimensions.
Showmodal as GraffitiModalInstanceNoneBegins the animation process to show the modal instance. Modal will not be completely shown until the Shown event is fired.

Properties #

NameTypeDefault ValueDescription
OverlayColorColorGroupNilColor applied to the image of the window’s contents behind the modal. Default is a transparent black color.
WindowDesktopWindowNilThis 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.