Class IgbContentPane
Inheritance
System.Object
IgbContentPane
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbContentPane : IgbDockManagerPane, JsonSerializable
Constructors
IgbContentPane()
Declaration
Properties
AcceptsInnerDock
Declaration
public bool AcceptsInnerDock { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowClose
Determines whether the end user is allowed to close the pane. Defaults to true.
Declaration
public bool AllowClose { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowDocking
Determines whether the end user is allowed to dock the pane. Defaults to true.
Declaration
public bool AllowDocking { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowFloating
Determines whether the end user is allowed to make the pane floating. Defaults to true.
Declaration
public bool AllowFloating { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowMaximize
Determines whether the end user is allowed to maximize the pane.
Declaration
public bool AllowMaximize { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
AllowPinning
Determines whether the end user is allowed to pin/unpin the pane. Defaults to true.
Declaration
public bool AllowPinning { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
ContentId
The slot attribute's value of the content element.
Declaration
public string ContentId { get; set; }
Property Value
Type |
Description |
System.String |
|
Disabled
Determines whether a pane is disabled. Defaults to false.
Declaration
public bool Disabled { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
DocumentOnly
Marks that a content pane can be docked only inside a document host.
Declaration
public bool DocumentOnly { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
The slot attribute's value of the floating header element. If not set, the headerId
property value is used.
Declaration
public string FloatingHeaderId { get; set; }
Property Value
Type |
Description |
System.String |
|
The text header of the content pane. Even if header slot templates are used, the text header is used for aria label.
Declaration
public string Header { get; set; }
Property Value
Type |
Description |
System.String |
|
The slot attribute's value of the content pane header element. If not set, the header
property value is used.
Declaration
public string HeaderId { get; set; }
Property Value
Type |
Description |
System.String |
|
Hidden
Determines whether a pane is hidden in the UI. Defaults to false.
Declaration
public bool Hidden { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
Id
The id of the pane. If not set the Dock Manager generates it automatically.
Declaration
public string Id { get; set; }
Property Value
Type |
Description |
System.String |
|
IsMaximized
Declaration
public bool IsMaximized { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
IsPinned
Determines whether a content pane is pinned or not. Defaults to true.
Declaration
public bool IsPinned { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
PaneType
Declaration
[WCWidgetMemberName("Type")]
public DockManagerPaneType PaneType { get; set; }
Property Value
Size
The size of the pane relative to its sibling panes' sizes. Defaults to 100.
Declaration
public double Size { get; set; }
Property Value
Type |
Description |
System.Double |
|
The slot attribute's value of the tab header element. If not set, the header
property value is used.
Declaration
public string TabHeaderId { get; set; }
Property Value
Type |
Description |
System.String |
|
Type
Declaration
public override string Type { get; }
Property Value
Type |
Description |
System.String |
|
Overrides
The slot attribute's value of the unpinned header element. If not set, the header
property value is used.
Declaration
public string UnpinnedHeaderId { get; set; }
Property Value
Type |
Description |
System.String |
|
UnpinnedLocation
The desired unpinned location of the content pane.
If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host.
If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation.
If there is no document host, the default location is left.
Declaration
public UnpinnedLocation UnpinnedLocation { get; set; }
Property Value
UnpinnedSize
The absolute size of the pane in an unpinned state. Defaults to 200.
Declaration
public double UnpinnedSize { get; set; }
Property Value
Type |
Description |
System.Double |
|
Methods
EnsureModulesLoaded()
Declaration
protected override void EnsureModulesLoaded()
Overrides
FindByName(String)
Declaration
public override object FindByName(string name)
Parameters
Type |
Name |
Description |
System.String |
name |
|
Returns
Type |
Description |
System.Object |
|
Overrides
FromEventJson(BaseRendererControl, Dictionary<String, Object>)
Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type |
Name |
Description |
BaseRendererControl |
control |
|
System.Collections.Generic.Dictionary<System.String, System.Object> |
args |
|
Overrides
SetNativeElement(Object)
Declaration
public void SetNativeElement(object element)
Parameters
Type |
Name |
Description |
System.Object |
element |
|
SetNativeElementAsync(Object)
Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type |
Name |
Description |
System.Object |
element |
|
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
ToEventJson(BaseRendererControl, Dictionary<String, Object>)
Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type |
Name |
Description |
BaseRendererControl |
control |
|
System.Collections.Generic.Dictionary<System.String, System.Object> |
args |
|
Overrides
Implements