TextPropertyControl
Text
MamlShortDescriptionControl
MamlParaTextItem
Text
MamlDetailsControl
4
Name
4
Description
MamlShortDescriptionControl
MamlIndentedDescriptionControl
4
description
MamlDescriptionControl
MamlDescriptionControl
MamlParaTextItem
Text
MamlOrderedListTextItem
4
Tag
Text
MamlUnorderedListTextItem
2
Tag
Text
MamlDefinitionTextItem
Term
4
Definition
MamlParameterControl
$optional = $_.required -ne "true"
$positional = (($_.position -ne $()) -and ($_.position -ne "") -and ($_.position -notmatch "named") -and ([int]$_.position -ne $()))
$parameterValue = if ($null -ne $_.psobject.Members['ParameterValue']) {
" <$($_.ParameterValue)>"
} elseif ($null -ne $_.psobject.Members['ParameterValueGroup']) {
" {$($_.ParameterValueGroup.ParameterValue -join ' | ')}"
} else {
""
}
$(if ($optional -and $positional) { "[[-{0}]{1}] " }
elseif ($optional) { "[-{0}{1}] " }
elseif ($positional) { "[-{0}]{1} " }
else { "-{0}{1} " }) -f $_.Name, $parameterValue
MamlParameterValueControl
if ($_.required -ne "true") { " [<$_>]" } else { " <$_>" }
ExamplesControl
Example
MamlExampleControl
MamlExampleControl
Title
Introduction
TextPropertyControl
Code
results
remarks
MamlShortDescriptionControl
MamlTypeControl
name
$_.uri
4
uri
$_.description
4
description
MamlShortDescriptionControl
MamlTextItem
MamlParaTextItem
Text
MamlOrderedListTextItem
Tag
Text
MamlUnorderedListTextItem
Tag
Text
MamlDefinitionTextItem
Term
4
Definition
MamlPreformattedTextItem
Text
MamlAlertControl
Text
MamlPossibleValuesControl
possibleValues
MamlPossibleValueControl
MamlPossibleValueControl
possibleValue
Value
4
Description
MamlShortDescriptionControl
MamlTrueFalseShortControl
$_.Equals("true", [System.StringComparison]::OrdinalIgnoreCase)
;
$_.Equals("false", [System.StringComparison]::OrdinalIgnoreCase)
;
MamlIndentedSyntaxControl
4
Syntax
MamlSyntaxControl
CommonWorkflowParametersControl
$wfp = $_.psobject.Properties['WorkflowCommonParameters']
if ($null -ne $wfp -and $wfp.Value)
{
if ($psversiontable.psversion.Major -gt 2)
{
$assembly = [System.Reflection.Assembly]::Load("System.Management.Automation")
$resourceManager = New-Object System.Resources.ResourceManager -ArgumentList "HelpDisplayStrings", $assembly
"[{0}]" -f $resourceManager.GetString("CommonWorkflowParameters")
}
else
{
"[<WorkflowCommonParameters>]"
}
}
MamlSyntaxControl
SyntaxItem
name
Parameter
MamlParameterControl
CommonWorkflowParametersControl
[
]
MamlTypeWithDescriptionControl
type
MamlTypeControl
4
description
MamlShortDescriptionControl
RelatedLinksHelpInfoControl
4
Set-StrictMode -Off
if(($psversiontable.psversion.Major -gt 2) -and ($_.relatedLinks -ne $()) -and ($_.relatedLinks.navigationLink -ne $()) -and ($_.relatedLinks.navigationLink.Length -ne 0))
{
$assembly = [System.Reflection.Assembly]::Load("System.Management.Automation")
$resourceManager = New-Object System.Resources.ResourceManager -ArgumentList "HelpDisplayStrings", $assembly
[String]::Format(" {0}{1}", $resourceManager.GetString("RelatedLinksHelpInfo"), "`"get-help " + $_.Details.Name + " -online`"`n")
}
MamlRelatedLinksControl
navigationLink
linkText
$_.linkText.Length -ne 0
" "
uri
ErrorControl
errorId
category
)
4
description
MamlShortDescriptionControl
type
MamlTypeControl
targetObjectType
MamlTypeControl
recommendedAction
MamlShortDescriptionControl
MamlFullParameterControl
-
name
ParameterValue
MamlParameterValueControl
4
Description
MamlDescriptionControl
$_.possibleValues -ne $()
MamlPossibleValuesControl
required
MamlTrueFalseShortControl
($_.position -eq $()) -or ($_.position -eq "")
$_.position -ne $()
$_.position
defaultValue
pipelineInput
globbing
MamlTrueFalseShortControl
zzz
Parameter
MamlFullParameterControl
4
help
HelpInfoShort
33
left
9
left
25
left
Name
Category
if ($_.ModuleName -ne $null) { $_.ModuleName } else {$_.PSSnapIn}
Synopsis
CmdletHelp
CmdletHelpInfo
4
Name
4
Syntax
DefaultCommandHelp
MamlCommandHelpInfo
Details
MamlDetailsControl
$_
MamlIndentedSyntaxControl
$_
MamlIndentedDescriptionControl
4
relatedLinks
MamlRelatedLinksControl
4
"
"get-help " + $_.Details.Name + " -examples"
".
"
"get-help " + $_.Details.Name + " -detailed"
".
"
"get-help " + $_.Details.Name + " -full"
".
RelatedLinksHelpInfoControl
VerboseCommandHelp
MamlCommandHelpInfo#DetailedView
Details
MamlDetailsControl
$_
MamlIndentedSyntaxControl
$_
MamlIndentedDescriptionControl
4
Parameters
Parameter
-
name
ParameterValue
MamlParameterValueControl
4
Description
MamlDescriptionControl
CommonWorkflowParametersControl
4
4
Examples
ExamplesControl
4
"
"get-help " + $_.Details.Name + " -examples"
".
"
"get-help " + $_.Details.Name + " -detailed"
".
"
"get-help " + $_.Details.Name + " -full"
".
RelatedLinksHelpInfoControl
ExampleCommandHelp
MamlCommandHelpInfo#ExamplesView
Details
MamlDetailsControl
4
Examples
ExamplesControl
FullCommandHelp
MamlCommandHelpInfo#FullView
Details
MamlDetailsControl
$_
MamlIndentedSyntaxControl
$_
MamlIndentedDescriptionControl
4
Parameters
zzz
4
InputTypes
InputType
MamlTypeWithDescriptionControl
4
ReturnValues
ReturnValue
MamlTypeWithDescriptionControl
(($_.terminatingErrors -ne $null) -and
($_.terminatingErrors.terminatingError -ne $null))
terminatingErrors
4
terminatingError
ErrorControl
(($_.nonTerminatingErrors -ne $null) -and
($_.nonTerminatingErrors.nonTerminatingError -ne $null))
nonTerminatingErrors
4
nonTerminatingError
ErrorControl
$_.alertSet -ne $null
alertSet
$_.alertSet -ne $null
alertSet
4
title
4
alert
MamlAlertControl
4
Examples
ExamplesControl
4
relatedLinks
MamlRelatedLinksControl
ProviderHelpInfo
ProviderHelpInfo
ProviderTasks
Task
Task
TaskExamplesControl
Example
TaskExampleControl
TaskExampleControl
Title
Introduction
TextPropertyControl
Code
results
remarks
MamlTextItem
Task
Title
4
Description
MamlTextItem
Examples
TaskExamplesControl
DynamicPossibleValues
4
Value
8
Description
MamlTextItem
DynamicParameterControl
-
Name
Type
"<" + $_.Name + ">"
4
Description
PossibleValues
PossibleValue
DynamicPossibleValues
CmdletSupported
4
Name
4
Drives
MamlTextItem
4
Synopsis
4
DetailedDescription
MamlTextItem
4
Capabilities
MamlTextItem
4
Tasks
ProviderTasks
4
DynamicParameters
DynamicParameter
DynamicParameterControl
4
Notes
4
relatedLinks
MamlRelatedLinksControl
FaqHelpInfo
FaqHelpInfo
Title
Question
4
Answer
MamlTextItem
GeneralHelpInfo
GeneralHelpInfo
Title
4
Content
MamlTextItem
GlossaryHelpInfo
GlossaryHelpInfo
Name
4
Definition
MamlTextItem
ScriptHelpInfo
ScriptHelpInfo
Title
4
Content
MamlTextItem
MamlCommandExamples
MamlCommandHelpInfo#Examples
$_
ExamplesControl
MamlCommandExample
MamlCommandHelpInfo#Example
Title
Introduction
TextPropertyControl
Code
results
remarks
MamlShortDescriptionControl
MamlCommandDetails
MamlCommandHelpInfo#commandDetails
4
Name
4
commandDescription
MamlShortDescriptionControl
MamlCommandParameters
MamlCommandHelpInfo#Parameters
4
zzz
MamlCommandParameterView
MamlCommandHelpInfo#Parameter
$_
MamlFullParameterControl
MamlCommandSyntax
MamlCommandHelpInfo#Syntax
$_
MamlSyntaxControl
MamlText
MamlParaTextItem
MamlOrderedListTextItem
MamlUnorderedListTextItem
MamlDefinitionTextItem
$_
MamlDescriptionControl
MamlInputTypes
MamlCommandHelpInfo#inputTypes
InputType
MamlTypeWithDescriptionControl
MamlNonTerminatingErrors
MamlCommandHelpInfo#nonTerminatingErrors
nonTerminatingError
ErrorControl
MamlTerminatingErrors
MamlCommandHelpInfo#terminatingErrors
terminatingError
ErrorControl
MamlRelatedLinks
MamlCommandHelpInfo#relatedLinks
$_
MamlRelatedLinksControl
MamlReturnTypes
MamlCommandHelpInfo#returnValues
ReturnValue
MamlTypeWithDescriptionControl
MamlAlertSet
MamlCommandHelpInfo#alertSet
title
4
alert
MamlAlertControl
MamlDetails
MamlCommandHelpInfo#details
$_
MamlDetailsControl