LgDocument
Module : Lagoon.UI
Namespace : Lagoon.UI.Components
Category: Document
Inherits from: LgComponentBase
Componant used to download and display a document behind a protected api or not
Parameters
| Parameter | Type | Description |
|---|---|---|
AdditionalAttributes | IReadOnlyDictionary<string, object> | Gets or sets a collection of additional attributes that will be applied to the created element. |
AllowDelete | bool | Get or set the flag indicating if delete function is supported. If true the ControllerUri path must support DELETE http verb. |
AnonymousRequest | bool | Specifies not to add the authentication token to the HTTP request to the server. default false. |
ChildContent | RenderFragment<string> | Get or set a custom render fragment. The parameter provided in the render fragment is a document browser url (eg blob://...data-url...) |
ClickBehaviour | DocumentClickBehaviour | Get or set the behaviour when the user click on the image. Default is DocumentClickBehaviour.None. |
ControllerUri | string | API Controller Uri |
CssClass | string | Gets or sets the CSS class |
Filename | string | Get or set the optional filename used when downloading (via browser) or opening image in modal |
Kind | DocumentKind | Get or set the kind of document to display Default is DocumentKind.IFrame |
LoaderContent | RenderFragment<int> | Get or set the render frangement used while downloading data |
OnClick | EventCallback | Get or set the event fired when user click on the image |
OnDelete | EventCallback | Get or set the event fired when an Http Delete has been successfully sent to the ControllerUri |
ShowDownloadProgression | bool | Get or set the flag used to show download progression. Should not be enabled for small document. Default is false |
Tooltip | string | Gets or sets the icon tooltip. |
TooltipIsHtml | bool | Gets or sets if the tooltip contents use the HTML format; else, the content use a raw text format. |
VideoAutoPlay | bool | Auto play the video. |
VideoControlsDisabled | bool | Activate the controls on the video. |
Cascading parameters
| Parameter | Type | Description |
|---|---|---|
ImageCache | LgDocumentsCache | Optional parent component used to cache downloaded document |