![\"image\"](\"http:\/\/www.sapien.com\/blog\/wp-content\/uploads\/2014\/04\/image10.png\" "\\"image\\"")
<\/a> <\/p>\nLet\u2019s cover each field of the Function Builder and how to create a function.<\/p>\n
Cmdlet Name<\/strong><\/p>\n The function builder provides you with a verb and noun field. The verb field contains a combo box with a list of approved verbs, but you have the option to enter your own unapproved verb if necessary.<\/p>\n Synopsis & Description<\/strong><\/p>\n You have the option to enter a quick synopsis and a longer description using these fields. The information provided here will be used to generate the function\u2019s comment-based help.<\/p>\n Cmdlet Binding<\/strong><\/p>\n Check the \u201cEnable Cmdlet Binding\u201d<\/em> option if you want your function to behave like a cmdlet and take advantage of PowerShell\u2019s built-in parameters such as Debug <\/em>and Verbose<\/em> and\/or process input from the pipeline. <\/p>\n This option will add the [CmdlingBinding] attribute to your function:<\/p>\n You can set the cmdlet binding attributes by using the properties grid:<\/p>\n <\/p>\n Parameter Sets<\/strong><\/p>\n The function builder allows you to specify multiple parameter sets, including a default.<\/p>\n Once you define a parameter set, you can assign it to each individual parameter.<\/p>\n Output Type<\/strong><\/p>\n You can specify the output type of the function and the appropriate attribute will be added: <\/p>\n The output type field also allows you to select from existing types:<\/p>\n The output type field also provides code completion for namespaces and types.<\/p>\n Parameters<\/strong><\/p>\n The function builder makes adding a parameter as simple as typing in a name:<\/p>\n The grid of parameters, allows you to mark the parameter as mandatory, provide a name, parameter type and assign a property set. If needed, you can press the Details<\/em> button or press (Ctrl + E) to open the parameter editor for more advanced settings.<\/p>\n <\/p>\n Parameter Editor<\/strong><\/p>\n Pressing the New Parameter<\/em> button or the Details<\/em> button will bring up the parameter editor:<\/p>\n Use the parameter editor dialog to edit the details of a specific parameter such as adding validation and aliases. <\/p>\n Parameter Name:<\/strong><\/em><\/p>\n Use this field to change the name of the parameter.<\/p>\n Description:<\/strong><\/em><\/p>\n The description of the parameter that will appear in the help comment.<\/p>\n Alias:<\/em><\/strong><\/p>\n (Optional) Provides an alternative name for the parameter.<\/p>\n Type:<\/em><\/strong><\/p>\n Specify the object type of the parameter. Checking the \u201cSwitch Parameter\u201d will make the parameter a switch parameter. This is the same as typing \u201cswitch\u201d in the type field.<\/p>\n Settings:<\/strong><\/em><\/p>\n In the settings you set the parameter\u2019s attributes, such as marking the parameter as mandatory.<\/p>\n A helpful description is displayed in when editing a parameter attribute.<\/p>\n Validation:<\/em><\/strong><\/p>\n The parameter editor also allows you to apply validation attributes to the parameter. Using the Add<\/em> button you can select and add a validation type and in turn it will be added to the validation list:<\/p>\n Once added, you can modify the validation attribute using the property grid:<\/p>\n Parameter Set:<\/em><\/strong><\/p>\n You can also set the parameter\u2019s parameter set assignment with in the parameter editor:<\/p>\n<\/a><\/p>\nfunction<\/span> <\/span>Get-Noun<\/span> {\r\n [<\/span>CmdletBinding<\/span>(SupportsShouldProcess <\/span>=<\/span> <\/span>$true<\/span>)]\r\n <\/span>param<\/span> ()\r\n <\/span>if<\/span> (<\/span>$pscmdlet<\/span>.ShouldProcess(<\/span>\"Target\"<\/span>, <\/span>\"Operation\"<\/span>)) {\r\n \r\n }\r\n}<\/span><\/pre>\n<\/a><\/p>\n
The property grid provides a help description of each attribute.<\/p>\n<\/a> <\/p>\nfunction<\/span> <\/span>Get-Noun<\/span> {\r\n [<\/span>CmdletBinding<\/span>()]\r\n [<\/span>OutputType<\/span>([<\/span>string<\/span>])]\r\n <\/span>param<\/span> ()\r\n\r\n}\r\n<\/span><\/pre>\n<\/a> <\/p>\n<\/a> <\/p>\n<\/p>\n<\/p>\n<\/p>\n<\/p>\n<\/a> <\/p>\n<\/a> <\/p>\n<\/a> <\/p>\n<\/a> <\/p>\n<\/p>\n<\/p>\n<\/a> <\/p>\n