|
Window Framework for UI Toolkit v2.0.x
|
A content-sized presentation card with a fixed header/footer and a scrolling body. More...


Public Member Functions | |
| CardElement () | |
| Creates the internal card structure, with header visible and footer hidden. | |
| void | RequestDismiss () |
| Requests user dismissal; required cards reject the request. | |
Properties | |
| bool | AllowDismiss = true [get, set] |
| Allows user dismissal requests. Does not prevent application-authorized removal. | |
| bool | AllowOutsideDismiss = true [get, set] |
| Allows the modal backdrop to request dismissal; AllowDismiss must also permit it. | |
| VisualElement | Body [get] |
| Container for application-owned form content and UXML children. | |
| Button | CloseButton [get] |
| User-dismissal button. Visibility and dismissal permission are independent. | |
| override VisualElement | contentContainer [get] |
| Routes Add() and UXML child creation into Body, not the internal card structure. | |
| VisualElement | Footer [get] |
| Non-scrolling application action area, hidden by default without discarding children. | |
| VisualElement | Header [get] |
| Non-scrolling header containing the title and close affordance. | |
| ScrollView | ScrollView [get] |
| Vertical scrolling body viewport; header/footer remain outside this scroll view. | |
| bool | ShowCloseButton [get, set] |
| Controls close-button visibility only; hiding it does not disable outside dismissal. | |
| bool | ShowFooter [get, set] |
| Shows/hides the footer while retaining application controls. Default is false. | |
| bool | ShowHeader [get, set] |
| Shows/hides the header while retaining its title and button contents. | |
| string | Title [get, set] |
| Displayed plain-text title; does not identify the card in persistence or telemetry. | |
| Label | TitleLabel [get] |
| Plain-text title label; rich-text interpretation is disabled. | |
Events | |
| Action< CardElement > | DismissRequested |
| Requests removal of this exact card; the modal owner performs timed cleanup. | |
A content-sized presentation card with a fixed header/footer and a scrolling body.
A card is deliberately not a WindowFrame: it has no controller registration, layout-memory identity, dragger, resizer or independent fullscreen state. WindowModal owns its queue slot, presentation, focus policy and fade/removal sequence. The application owns the form controls and any business operation performed by them; closing a card does not grant a reward or submit data. Set card width/max-width in developer USS (pixels or percentages); the modal constrains the card to the available viewport. UXML children and Add() target Body so header/footer never scroll. Framework presentation uses the wfw-modal-* theme roles. Required forms should set AllowDismiss false and hide the close button. There is no automatic Escape binding: applications own input.
|
inline |
Creates the internal card structure, with header visible and footer hidden.
Construct detached, populate Body/Footer, then pass the card to the existing controller's ShowModal(CardElement) or an owned WindowModal.AddCard. No asset loading or window registration is performed here. Panel attachment telemetry is observation only.


|
inline |
Requests user dismissal; required cards reject the request.
Returns immediately. When AllowDismiss is true, invokes DismissRequested with this instance if a subscriber exists. With no owner/subscriber the request does not remove anything. When false, no event is raised. Subscriber exceptions propagate; this method performs neither validation nor resource disposal. WindowModal normally subscribes and schedules removal.


|
getset |
Allows user dismissal requests. Does not prevent application-authorized removal.
Set false for must-answer forms; the application still decides when a valid answer permits removal. This is behavior configuration, never a portable theme field.
|
getset |
Allows the modal backdrop to request dismissal; AllowDismiss must also permit it.
|
get |
Container for application-owned form content and UXML children.
|
get |
User-dismissal button. Visibility and dismissal permission are independent.
|
get |
Routes Add() and UXML child creation into Body, not the internal card structure.
|
get |
Non-scrolling application action area, hidden by default without discarding children.
|
get |
Non-scrolling header containing the title and close affordance.
|
get |
Vertical scrolling body viewport; header/footer remain outside this scroll view.
|
getset |
Controls close-button visibility only; hiding it does not disable outside dismissal.
|
getset |
Shows/hides the footer while retaining application controls. Default is false.
|
getset |
Shows/hides the header while retaining its title and button contents.
|
getset |
Displayed plain-text title; does not identify the card in persistence or telemetry.
|
get |
Plain-text title label; rich-text interpretation is disabled.
| Action<CardElement> GWG.WindowFramework.CardElement.DismissRequested |
Requests removal of this exact card; the modal owner performs timed cleanup.
A request is not synchronous removal. Do not independently detach the card from this callback: WindowModal must retain the slot until opacity fades, then slide the queue upward. Application-authorized completion uses WindowModal.RemoveCard instead of user dismissal.