API Reference
PacketLayoutBlock
A deterministic packet-layout visual block made of contiguous labeled bit fields.
Inheritance
- VisualBlock<PacketLayoutBlock>
- PacketLayoutBlock
Usage
Explore 22 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 22
- Extension method MermaidPacketDocument.ToPacketLayoutBlock
- Method MermaidPacketRendering.ToPacketLayoutBlock
- Method PacketLayoutBlock.AddField
- Method PacketLayoutBlock.ConfigureTheme
- Method PacketLayoutBlock.Create
- Method PacketLayoutBlock.WithBitNumbers
- Method PacketLayoutBlock.WithBitOrder
- Method PacketLayoutBlock.WithBitsPerRow
- Method PacketLayoutBlock.WithBitWidth
- Method PacketLayoutBlock.WithCard
- Method PacketLayoutBlock.WithFieldGap
- Method PacketLayoutBlock.WithHostFrame
- Method PacketLayoutBlock.WithPadding
- Method PacketLayoutBlock.WithPngOutputScale
- Method PacketLayoutBlock.WithRowGap
- Method PacketLayoutBlock.WithRowHeight
- Method PacketLayoutBlock.WithSize
- Method PacketLayoutBlock.WithSubtitle
- Method PacketLayoutBlock.WithTheme
- Method PacketLayoutBlock.WithThemeMode
- Method PacketLayoutBlock.WithTitle
- Method PacketLayoutBlock.WithTransparentBackground
Constructors
public PacketLayoutBlock() #Methods
public PacketLayoutBlock AddField(Int32 startBit, Int32 endBit, String label) #PacketLayoutBlockAdds one contiguous field.
Parameters
- startBit System.Int32
- endBit System.Int32
- label System.String
public PacketLayoutBlock WithBitNumbers(Boolean visible = true) #PacketLayoutBlockSets whether bit start and end numbers are rendered above fields.
Parameters
- visible System.Boolean = true
public PacketLayoutBlock WithBitOrder(PacketBitOrder order) #PacketLayoutBlockSets the visual bit direction within each row.
Parameters
- order ChartForgeX.VisualBlocks.PacketBitOrder
public PacketLayoutBlock WithBitsPerRow(Int32 bitsPerRow) #PacketLayoutBlockSets how many bits are rendered per visual row.
Parameters
- bitsPerRow System.Int32
public PacketLayoutBlock WithBitWidth(Double? width) #PacketLayoutBlockSets the preferred bit width; the renderer fits it to the available row width.
Parameters
- width System.Double?
public PacketLayoutBlock WithFieldGap(Double? gap) #PacketLayoutBlockSets the preferred gap between fields; each field retains positive width.
Parameters
- gap System.Double?
public PacketLayoutBlock WithRowGap(Double? gap) #PacketLayoutBlockSets the preferred gap between rows; the renderer fits it to the available height.
Parameters
- gap System.Double?
public PacketLayoutBlock WithRowHeight(Double? height) #PacketLayoutBlockSets the preferred field height; the renderer fits it to the available row height.
Parameters
- height System.Double?
Inherited Methods
public PacketLayoutBlock ConfigureTheme(Action<VisualThemeBuilder> configure) #PacketLayoutBlockParameters
- configure Action<VisualThemeBuilder>
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
public virtual RgbaImage RenderRgba() #RgbaImagepublic virtual String RenderSvg(String idScope) #StringParameters
- idScope String
public PacketLayoutBlock WithCard(Boolean enabled = true) #PacketLayoutBlockParameters
- enabled Boolean = true
public PacketLayoutBlock WithHostFrame(Boolean hostOwnsFrame = true) #PacketLayoutBlockParameters
- hostOwnsFrame Boolean = true
public PacketLayoutBlock WithPadding(Double padding) #PacketLayoutBlockParameters
- padding Double
public PacketLayoutBlock WithPadding(Double left, Double top, Double right, Double bottom) #PacketLayoutBlockParameters
- left Double
- top Double
- right Double
- bottom Double
public PacketLayoutBlock WithPngOutputScale(Int32 scale) #PacketLayoutBlockParameters
- scale Int32
public PacketLayoutBlock WithSize(Int32 width, Int32 height) #PacketLayoutBlockParameters
- width Int32
- height Int32
public PacketLayoutBlock WithSubtitle(String subtitle) #PacketLayoutBlockParameters
- subtitle String
public PacketLayoutBlock WithTheme(VisualTheme theme, VisualThemeMode? mode = null) #PacketLayoutBlockParameters
- theme VisualTheme
- mode VisualThemeMode? = null
public PacketLayoutBlock WithThemeMode(VisualThemeMode mode) #PacketLayoutBlockParameters
- mode VisualThemeMode
public PacketLayoutBlock WithTitle(String title) #PacketLayoutBlockParameters
- title String
public PacketLayoutBlock WithTransparentBackground(Boolean enabled = true) #PacketLayoutBlockParameters
- enabled Boolean = true
Properties
public IReadOnlyList<PacketLayoutField> Fields { get; } #Gets packet fields in bit order.
public Int32 BitsPerRow { get; set; } #Gets or sets how many bits are rendered per visual row.
public Boolean ShowBitNumbers { get; set; } #Gets or sets whether bit start and end numbers are rendered above fields when they fit the available space.
public Double? BitWidth { get; set; } #Gets or sets the preferred width of one bit in logical pixels; null fills the available row.
public Double? RowHeight { get; set; } #Gets or sets the preferred field height in logical pixels; null uses automatic row sizing.
public Double? FieldGap { get; set; } #Gets or sets the gap between fields in logical pixels; null uses the native one-pixel gap.
public Double? RowGap { get; set; } #Gets or sets the gap between rows in logical pixels; null uses automatic spacing.
public PacketBitOrder BitOrder { get; set; } #Gets or sets the visual bit direction within each row without changing field ranges.
public override String AccessibleName { get; } #Gets a concise accessibility label.