Lib/Default/PowerBGInfo.PowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>PowerBGInfo.PowerShell</name> </assembly> <members> <member name="T:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration"> <summary>Exports a BGInfo configuration to JSON.</summary> <para>Writes a JSON file compatible with Invoke-BGInfo and the CLI.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration.InputObject"> <para>Configuration object to export.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration.Path"> <para>Output path for the JSON configuration file.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration.Force"> <para>Overwrite the output file if it exists.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration.PassThru"> <para>Return the output path.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletExportBGInfoConfiguration.ProcessRecord"> <summary>Writes the JSON configuration file.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletInvokeBGInfo"> <summary>Runs BGInfo from a JSON configuration file.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.Path"> <para>Path to the JSON configuration file.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.OutputFileName"> <para>Override output file name.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.ConfigurationDirectory"> <para>Override configuration output directory.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.MonitorIndex"> <para>Override monitor index.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.Target"> <para>Override output target.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.NoApply"> <para>Generate the image without applying it to the wallpaper.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletInvokeBGInfo.EndProcessing"> <summary>Loads the configuration and runs BGInfo.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfo"> <summary>Creates a BGInfo overlay image and optionally applies it as wallpaper.</summary> <para>Use the script block to emit label/value entries.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.BGInfoContent"> <para>Script block that outputs BGInfo entries.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.FilePath"> <para>Optional base wallpaper file path. When omitted, current wallpaper is used.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.OutputFileName"> <para>Optional output file name for the generated image.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ConfigurationDirectory"> <para>Output directory for generated BGInfo images.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.FontFamilyName"> <para>Default label font family.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.Color"> <para>Default label color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.BackgroundColor"> <para>Background color to use when no wallpaper image is available.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.FontSize"> <para>Default label font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ValueColor"> <para>Default value color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ValueFontSize"> <para>Default value font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ValueFontFamilyName"> <para>Default value font family.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ValueWrapWidth"> <para>Maximum width used when wrapping value text. Set to 0 to disable wrapping.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.SpaceBetweenLines"> <para>Vertical spacing between rows.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.SpaceBetweenColumns"> <para>Spacing between label and value columns.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.PositionX"> <para>Legacy position X placeholder (reserved for future layout strategies).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.PositionY"> <para>Legacy position Y placeholder (reserved for future layout strategies).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.MonitorIndex"> <para>Monitor index to target for wallpaper operations.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.SpaceX"> <para>X padding used for layout positioning.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.SpaceY"> <para>Y padding used for layout positioning.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.WallpaperFit"> <para>Wallpaper fit mode used after generation.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.TextPosition"> <para>Layout anchor position (for example TopLeft, TopCenter, BottomRight).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.Target"> <para>Output target (Wallpaper, File, LogonScreen, or Both).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartLayout"> <para>Chart layout mode.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackAnchor"> <para>Anchor used when stacking charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackDirection"> <para>Direction used when stacking charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackSpacing"> <para>Spacing between stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackOffsetX"> <para>Horizontal offset for stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackOffsetY"> <para>Vertical offset for stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackAlignToTextBlock"> <para>Align stacked charts to the text block.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ChartStackOutsideTextBlock"> <para>Place stacked charts outside the text block.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.AllUsers"> <para>Apply wallpaper for all user profiles.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ExcludeDefaultUserProfile"> <para>Exclude the default user profile when applying to all users.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.DisableWallpaperRefresh"> <para>Disable the forced wallpaper refresh after generation.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.UseScreenCoordinates"> <para>Use screen coordinates for placement calculations.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.JsonPath"> <para>Optional path where the generated configuration JSON should be saved.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.ExportOnly"> <para>Export JSON only and skip image generation/application. Requires JsonPath.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfo.PassThru"> <para>Return the generated configuration object instead of rendering the image.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfo.ProcessRecord"> <summary>Processes the BGInfo script block and generates the image.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoChart"> <summary>Creates a BGInfo chart definition.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Title"> <para>Chart title displayed above the plot.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Id"> <para>Chart identifier used for history storage.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Kind"> <para>Chart kind to render, such as Sparkline, Line, Area, Bar, HorizontalBar, Gauge, Circle, RadialBar, Bullet, Pie, Donut, ProgressBar, or Pictorial.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Value"> <para>Single value to append.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Values"> <para>Multiple values to append or replace.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Labels"> <para>Optional labels used by point-based charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Target"> <para>Target value used by bullet charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.RangeEnds"> <para>Qualitative range ends used by bullet charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Metric"> <para>Built-in metric source used when no explicit values are provided.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.MetricArgument"> <para>Optional metric argument (for example drive letter).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Width"> <para>Chart width in pixels.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Height"> <para>Chart height in pixels.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Anchor"> <para>Anchor position for placement.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.OffsetX"> <para>Horizontal offset from the anchor.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.OffsetY"> <para>Vertical offset from the anchor.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.PositionX"> <para>Absolute X position for placement.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.PositionY"> <para>Absolute Y position for placement.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.MaxPoints"> <para>Maximum number of samples to keep in history.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoHistory"> <para>Disable history storage and render only provided values.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ReplaceHistory"> <para>Replace history instead of appending values.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.LineColor"> <para>Line or bar color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.FillColor"> <para>Fill color for sparklines.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Palette"> <para>Palette colors for point-based charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.BackgroundColor"> <para>Background color for the chart block.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.TextColor"> <para>Text color for title/value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.FontFamilyName"> <para>Font family for title and value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.TitleFontSize"> <para>Title font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ValueFontSize"> <para>Value font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ShowLatestValue"> <para>Show the latest value text.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ValueFormat"> <para>Format string for the latest value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ValueSuffix"> <para>Suffix appended to the latest value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.BarGap"> <para>Gap between bars (0-1).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Padding"> <para>Padding inside the chart.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ShowGrid"> <para>Show chart grid lines.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.GridColor"> <para>Grid line color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.GridLineCount"> <para>Number of horizontal grid lines.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ShowLegend"> <para>Show the chart legend.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ShowPointLegend"> <para>Show point-level legend entries.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.LegendPosition"> <para>Chart legend position.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ShowDataLabels"> <para>Show supported data labels.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Minimum"> <para>Optional minimum scale value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.Maximum"> <para>Optional maximum scale value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoDonutCenterLabel"> <para>Hide donut center label.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.DonutInnerRadiusRatio"> <para>Donut inner radius ratio.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.DonutCenterValue"> <para>Donut center value text.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.DonutCenterLabel"> <para>Donut center label text.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoRadialBarCenterLabel"> <para>Hide radial-bar center label.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoCircleStatusLabel"> <para>Hide circle status label.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoProgressValues"> <para>Hide progress values.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.NoProgressHandles"> <para>Hide progress handles.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.ProgressBarThicknessRatio"> <para>Progress-bar thickness ratio.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.PictorialSymbol"> <para>Pictorial chart symbol.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.PictorialColumns"> <para>Pictorial symbols per row.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoChart.EndProcessing"> <summary>Emits a BGInfo chart definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration"> <summary>Creates a BGInfo configuration object.</summary> <para>Use this to build reusable configurations that can be exported to JSON.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.FilePath"> <para>Optional base wallpaper file path.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.OutputFileName"> <para>Optional output file name for the generated image.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ConfigurationDirectory"> <para>Output directory for generated BGInfo images.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.FontFamilyName"> <para>Default label font family.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Color"> <para>Default label color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.BackgroundColor"> <para>Background color to use when no wallpaper image is available.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.FontSize"> <para>Default label font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ValueColor"> <para>Default value color.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ValueFontSize"> <para>Default value font size.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ValueFontFamilyName"> <para>Default value font family.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ValueWrapWidth"> <para>Maximum width used when wrapping value text. Set to 0 to disable wrapping.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.SpaceBetweenLines"> <para>Vertical spacing between rows.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.SpaceBetweenColumns"> <para>Spacing between label and value columns.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.PositionX"> <para>Legacy position X placeholder.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.PositionY"> <para>Legacy position Y placeholder.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.MonitorIndex"> <para>Monitor index to target for wallpaper operations.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.SpaceX"> <para>X padding used for layout positioning.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.SpaceY"> <para>Y padding used for layout positioning.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.WallpaperFit"> <para>Wallpaper fit mode used after generation.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.TextPosition"> <para>Layout anchor position.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Target"> <para>Output target (Wallpaper, File, LogonScreen, or Both).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartLayout"> <para>Chart layout mode.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackAnchor"> <para>Anchor used when stacking charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackDirection"> <para>Direction used when stacking charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackSpacing"> <para>Spacing between stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackOffsetX"> <para>Horizontal offset for stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackOffsetY"> <para>Vertical offset for stacked charts.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackAlignToTextBlock"> <para>Align stacked charts to the text block.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ChartStackOutsideTextBlock"> <para>Place stacked charts outside of the text block.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.AllUsers"> <para>Apply wallpaper for all user profiles.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.ExcludeDefaultUserProfile"> <para>Exclude the default user profile when applying to all users.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.DisableWallpaperRefresh"> <para>Disable wallpaper refresh (keep old behavior).</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.UseScreenCoordinates"> <para>Use screen coordinates for layout positioning.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Entries"> <para>Entries to include in the configuration.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Variables"> <para>Variables to include in the configuration.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Charts"> <para>Charts to include in the configuration.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.Topologies"> <para>Topology diagrams to include in the configuration.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoConfiguration.EndProcessing"> <summary>Creates the configuration object.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel"> <summary>Creates a BGInfo label entry.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.Name"> <para>Label text to render.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.ForEach"> <para>Variable name used to expand this label multiple times.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.Color"> <para>Label color override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.FontSize"> <para>Label font size override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.FontFamilyName"> <para>Label font family override.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoLabel.EndProcessing"> <summary>Emits a BGInfo label entry.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology"> <summary>Creates a BGInfo topology overlay definition.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.TopologyDefinition"> <para>Script block that emits topology groups, nodes, and edges.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Title"> <para>Topology title.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Subtitle"> <para>Topology subtitle.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Width"> <para>Topology width in pixels.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Height"> <para>Topology height in pixels.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Anchor"> <para>Anchor position for placement.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.OffsetX"> <para>Horizontal offset from the anchor.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.OffsetY"> <para>Vertical offset from the anchor.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.PositionX"> <para>Absolute X position.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.PositionY"> <para>Absolute Y position.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Layout"> <para>Topology layout mode.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Direction"> <para>Topology layout direction.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.NodeDisplayMode"> <para>Node presentation mode.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Theme"> <para>Theme name.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.Opaque"> <para>Use an opaque topology canvas.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.NoTitle"> <para>Hide the topology title.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.ShowLegend"> <para>Show the topology legend.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.NoGroups"> <para>Hide group containers.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.NoEdgeLabels"> <para>Hide edge labels.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoTopology.EndProcessing"> <summary>Emits a BGInfo topology overlay definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge"> <summary>Creates a BGInfo topology edge definition.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Id"> <para>Stable edge identifier. When omitted, one is derived from source and target ids.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.SourceNodeId"> <para>Source node identifier.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.TargetNodeId"> <para>Target node identifier.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Label"> <para>Primary edge label.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Kind"> <para>Relationship kind.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Status"> <para>Relationship health or state.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Direction"> <para>Direction marker behavior.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Routing"> <para>Edge routing mode.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Color"> <para>Optional edge color as CSS hex.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.Muted"> <para>Render the edge as a quiet structural relationship.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyEdge.EndProcessing"> <summary>Emits a topology edge definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup"> <summary>Creates a BGInfo topology group definition.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Id"> <para>Stable group identifier.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Label"> <para>Group label rendered in the topology.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Subtitle"> <para>Optional group subtitle.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Status"> <para>Group health or state.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Symbol"> <para>Short symbol rendered near the group header.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.Color"> <para>Optional group accent color as CSS hex.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyGroup.EndProcessing"> <summary>Emits a topology group definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode"> <summary>Creates a BGInfo topology node definition.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Id"> <para>Stable node identifier used by topology edges.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Label"> <para>Node label rendered in the topology.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Subtitle"> <para>Optional node subtitle.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Kind"> <para>Node kind used for icon and legend selection.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Status"> <para>Node health or state.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.GroupId"> <para>Optional parent group identifier.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Symbol"> <para>Short symbol rendered inside or near the node icon.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Badge"> <para>Optional badge text.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.Color"> <para>Optional node accent color as CSS hex.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.DisplayMode"> <para>Optional node display mode override.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoTopologyNode.EndProcessing"> <summary>Emits a topology node definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoValue"> <summary>Creates a BGInfo value entry.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.Name"> <para>Label text to render.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.Value"> <para>Explicit value to render.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.BuiltinValue"> <para>Built-in token to resolve to a value.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.Color"> <para>Label color override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.FontSize"> <para>Label font size override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.FontFamilyName"> <para>Label font family override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.ValueColor"> <para>Value color override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.ValueFontSize"> <para>Value font size override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.ValueFontFamilyName"> <para>Value font family override.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.ForEach"> <para>Variable name used to expand this entry multiple times.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoValue.EndProcessing"> <summary>Emits a BGInfo value entry.</summary> </member> <member name="T:PowerBGInfo.PowerShell.CmdletNewBGInfoVariable"> <summary>Creates a reusable BGInfo variable backed by a built-in provider.</summary> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoVariable.Name"> <para>Name used by -ForEach references.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoVariable.Provider"> <para>Built-in provider used to populate the variable.</para> </member> <member name="P:PowerBGInfo.PowerShell.CmdletNewBGInfoVariable.Argument"> <para>Optional provider argument for filtering/customization.</para> </member> <member name="M:PowerBGInfo.PowerShell.CmdletNewBGInfoVariable.EndProcessing"> <summary>Emits the BGInfo variable definition.</summary> </member> <member name="T:PowerBGInfo.PowerShell.PowerShellColorConverter"> <summary>Converts PowerShell-friendly color values into BGInfo colors.</summary> </member> <member name="T:OnModuleImportAndRemove"> <summary> OnModuleImportAndRemove is a class that implements the IModuleAssemblyInitializer and IModuleAssemblyCleanup interfaces. This class is used to handle the assembly resolve event when the module is imported and removed. </summary> </member> <member name="M:OnModuleImportAndRemove.OnImport"> <summary> OnImport is called when the module is imported. </summary> </member> <member name="M:OnModuleImportAndRemove.OnRemove(System.Management.Automation.PSModuleInfo)"> <summary> OnRemove is called when the module is removed. </summary> <param name="module"></param> </member> <member name="M:OnModuleImportAndRemove.MyResolveEventHandler(System.Object,System.ResolveEventArgs)"> <summary> MyResolveEventHandler is a method that handles the AssemblyResolve event. </summary> <param name="sender"></param> <param name="args"></param> <returns></returns> </member> <member name="M:OnModuleImportAndRemove.IsNetFramework"> <summary> Determine if the current runtime is .NET Framework </summary> <returns></returns> </member> <member name="M:OnModuleImportAndRemove.IsNet5OrHigher"> <summary> Determine if the current runtime is .NET 5 or higher </summary> <returns></returns> </member> </members> </doc> |