netcoreapp3.1/RoyalDocument.PowerShell.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Close-RoyalDocument</command:name> <command:verb>Close</command:verb> <command:noun>RoyalDocument</command:noun> <maml:description> <maml:para>Close (and unload) a Royal TS/X document from the RoyalStore.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will close and unload an opened Royal TS/X and removes it from the RoyalStore.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Close-RoyalDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force closes the RoyalDocument even if it has unsaved changes. Use with caution!</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force closes the RoyalDocument even if it has unsaved changes. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Close-RoyalDocument -Document $doc</dev:code> <dev:remarks> <maml:para>When using -Force, the Royal TS/X document is closed even if it has unsaved changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Close-RoyalServerDocument</command:name> <command:verb>Close</command:verb> <command:noun>RoyalServerDocument</command:noun> <maml:description> <maml:para>Close (and unload) a Royal TS/X document from the RoyalStore.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet will close (and unload) an opened Royal TS/X and removes it from the RoyalStore.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Close-RoyalServerDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force closes the RoyalDocument even if it has unsaved changes. Use with caution!</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force closes the RoyalDocument even if it has unsaved changes. Use with caution!</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document that will be closed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Close-RoyalDocument -Document $doc</dev:code> <dev:remarks> <maml:para>When using -Force, the Royal TS/X document is closed even if it has unsaved changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Copy-RoyalObject</command:name> <command:verb>Copy</command:verb> <command:noun>RoyalObject</command:noun> <maml:description> <maml:para>Copies an object to a destination folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet copies an object to a target folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-RoyalObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be copied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The target folder the object is copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be copied.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The target folder the object is copied to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object that is going to be copied.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Copy-RoyalObject -Object $folder -TargetFolder $anotherDocument</dev:code> <dev:remarks> <maml:para>This command creates a copy of the $folder in the target folder/document $anotherdocument.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalDocumentType</command:name> <command:verb>Get</command:verb> <command:noun>RoyalDocumentType</command:noun> <maml:description> <maml:para>Gets the type of the Royal TS/X document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets the configured document type of the Royal TS/X document (Merge for shared files or Overwrite for personal files).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalDocumentType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document of which the DocumentType should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document of which the DocumentType should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document of which the DocumentType should be returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalDocumentType -Document $document</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-RoyalDocumentType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalObject</command:name> <command:verb>Get</command:verb> <command:noun>RoyalObject</command:noun> <maml:description> <maml:para>Gets one or more objects from a document or folder by various search parameters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns one or more objects from a document or folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder (or document) that is going to be searched. Cannot be used in conjunction with the parameter Store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of objects that should be returned.</maml:para> <maml:para>Possible values: RoyalFolder, RoyalDynamicFolder, RoyalCredential, RoyalDynamicCredential, RoyalToDo, RoyalRDSConnection, RoyalVNCConnection, RoyalSSHConnection, RoyalFileTransferConnection, RoyalWebConnection, RoyalTeamViewerConnection, RoyalAppConnection, RoyalPerformanceConnection, RoyalPowerShellConnection, RoyalWindowsEventsConnection, RoyalWindowsProcessesConnection, RoyalWindowsServicesConnection, RoyalTerminalServicesConnection, RoyalHyperVConnection, RoyalVMwareConnection, RoyalManagementEndpoint, RoyalSecureGateway, RoyalRDSGateway, RoyalCommandTask, RoyalKeySequenceTask, RoyalApplicationSetting</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">RoyalFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDynamicFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalCredential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDynamicCredential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalToDo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalRDSConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalVNCConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalSSHConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalFileTransferConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWebConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalTeamViewerConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalAppConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalPerformanceConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalPowerShellConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsEventsConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsProcessesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsServicesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalTerminalServicesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalHyperVConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalVMwareConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalManagementEndpoint</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalSecureGateway</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalRDSGateway</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalCommandTask</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalKeySequenceTask</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalApplicationSetting</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectType</command:parameterValue> <dev:type> <maml:name>RoyalObjectType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RoyalFolder</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of objects that should be returned (Wildcard * is allowed).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore that should be searched. Cannot be used in conjunction with the parameter Folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>IncludeTrashcan</maml:name> <maml:description> <maml:para>If Trashcan (deleted objects) should be returned as well.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-RoyalObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder (or document) that is going to be searched. Cannot be used in conjunction with the parameter Store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore that should be searched. Cannot be used in conjunction with the parameter Folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>IncludeTrashcan</maml:name> <maml:description> <maml:para>If Trashcan (deleted objects) should be returned as well.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (Guid) fo the object to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder (or document) that is going to be searched. Cannot be used in conjunction with the parameter Store.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of objects that should be returned.</maml:para> <maml:para>Possible values: RoyalFolder, RoyalDynamicFolder, RoyalCredential, RoyalDynamicCredential, RoyalToDo, RoyalRDSConnection, RoyalVNCConnection, RoyalSSHConnection, RoyalFileTransferConnection, RoyalWebConnection, RoyalTeamViewerConnection, RoyalAppConnection, RoyalPerformanceConnection, RoyalPowerShellConnection, RoyalWindowsEventsConnection, RoyalWindowsProcessesConnection, RoyalWindowsServicesConnection, RoyalTerminalServicesConnection, RoyalHyperVConnection, RoyalVMwareConnection, RoyalManagementEndpoint, RoyalSecureGateway, RoyalRDSGateway, RoyalCommandTask, RoyalKeySequenceTask, RoyalApplicationSetting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectType</command:parameterValue> <dev:type> <maml:name>RoyalObjectType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>RoyalFolder</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of objects that should be returned (Wildcard * is allowed).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore that should be searched. Cannot be used in conjunction with the parameter Folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>IncludeTrashcan</maml:name> <maml:description> <maml:para>If Trashcan (deleted objects) should be returned as well.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (Guid) fo the object to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalFolder</maml:name> </dev:type> <maml:description> <maml:para>The folder (or document) that is going to be searched. Cannot be used in conjunction with the parameter Store.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalObject -Folder $doc -Type RoyalFolder -Name "Fold*" | Select-Object Name</dev:code> <dev:remarks> <maml:para>This cmdlet returns all Folders from $doc that start with "Fold" in its Name property.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalObjectCustomProperty</command:name> <command:verb>Get</command:verb> <command:noun>RoyalObjectCustomProperty</command:noun> <maml:description> <maml:para>Gets one or more custom properties from an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves one or more custom properties from a given object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocument.PowerShell.RoyalObjectCmdLets.CustomProperty[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalObjectCustomProperty -Object $object</dev:code> <dev:remarks> <maml:para>This cmdlet returns all custom properties from $object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-RoyalObjectCustomProperty -Object $object -Id $propertyId</dev:code> <dev:remarks> <maml:para>This cmdlet returns the custom property with the id $propertyId from $object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomPropertyPosition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalObjectValue</command:name> <command:verb>Get</command:verb> <command:noun>RoyalObjectValue</command:noun> <maml:description> <maml:para>Get the value from an object's property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet retrieves an object property value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalObjectValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object of which the property value is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>The object's property name that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object of which the property value is returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>The object's property name that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object of which the property value is returned.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$createdDatetime = Get-RoyalObjectValue -Object $obj -Property "Created"</dev:code> <dev:remarks> <maml:para>$obj needs to be of type RoyalObject. Normally, when you create a variable using New-RoyalObject, you get back the exact type requested. For this cmdlet, first cast the variable to a RoyalObject (the base class) like so: [RoyalDocumentLibrary.RoyalObject]$obj = $folder.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalPropertyHelp</command:name> <command:verb>Get</command:verb> <command:noun>RoyalPropertyHelp</command:noun> <maml:description> <maml:para>Gets help information on a property of a RoyalObject.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-RoyalPropertyHelp displays information about properties on RoyalObjects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalPropertyHelp</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertyName</maml:name> <maml:description> <maml:para>Filters the (partial) name of the property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filters the (partial) category name of the property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClassName</maml:name> <maml:description> <maml:para>Filters the (partial) class name (e.g. RoyalSSHConnection or RoyalRDSConnection).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertyName</maml:name> <maml:description> <maml:para>Filters the (partial) name of the property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Filters the (partial) category name of the property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ClassName</maml:name> <maml:description> <maml:para>Filters the (partial) class name (e.g. RoyalSSHConnection or RoyalRDSConnection).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalPropertyHelp -PropertyName "Font" $doc = New-RoyalDocument -Store $store -FileName doc.rtsz -Name "documentname"</dev:code> <dev:remarks> <maml:para>The variable $store is used for New-RoyalDocument cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RoyalServerDocument</command:name> <command:verb>Get</command:verb> <command:noun>RoyalServerDocument</command:noun> <maml:description> <maml:para>Gets a list of all available Royal TS/X documents stored on a Royal Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet gets a list of all Royal TS/X documents on a Royal Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RoyalServerDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalManagementEndpoint</maml:name> </dev:type> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-RoyalServerDocument -RoyalServer $server</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Open-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Close-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-RoyalObject</command:name> <command:verb>Move</command:verb> <command:noun>RoyalObject</command:noun> <maml:description> <maml:para>Moves an object to another target folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet moves an object to a target folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Move-RoyalObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The target folder where the RoyalObject moved to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be moved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TargetFolder</maml:name> <maml:description> <maml:para>The target folder where the RoyalObject moved to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object that is going to be moved.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Move-RoyalObject -Object $folder -TargetFolder $anotherDocument</dev:code> <dev:remarks> <maml:para>This command moves $folder to $anotherDocument.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-RoyalDocument</command:name> <command:verb>New</command:verb> <command:noun>RoyalDocument</command:noun> <maml:description> <maml:para>Creates a new Royal TS/X document (.rtsz file).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new (empty) Royal TS/X document in memory.</maml:para> <maml:para>Use the New-RoyalObject cmdlet to create and add more objects (folder, connections, credentials or tasks) to the document.</maml:para> <maml:para>To save the document to disk, use Out-RoyalDocument cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RoyalDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore to which the new Royal TS/X document will be assigned. See also New-RoyalStore cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Royal TS/X document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name where the document should be saved when the Out-RoyalDocument cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The document password for the Royal TS/X document. If not specified, the document created will not be password protected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The document's lockdown password. If specified, the document will be created as a lockdown document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LockdownPolicy</maml:name> <maml:description> <maml:para>The document's lockdown policies. If not specified, no policies will be enforced. If specified, a LockdownPassword is required.</maml:para> <maml:para>Possible values: HidePasswords, ReadOnly, AllowPasswordsInWebPage</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">HidePasswords</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReadOnly</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllowPasswordsInWebPage</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">LockdownPolicy</command:parameterValue> <dev:type> <maml:name>LockdownPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HidePasswords</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="6" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore to which the new Royal TS/X document will be assigned. See also New-RoyalStore cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Royal TS/X document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name where the document should be saved when the Out-RoyalDocument cmdlet is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The document password for the Royal TS/X document. If not specified, the document created will not be password protected.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The document's lockdown password. If specified, the document will be created as a lockdown document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>LockdownPolicy</maml:name> <maml:description> <maml:para>The document's lockdown policies. If not specified, no policies will be enforced. If specified, a LockdownPassword is required.</maml:para> <maml:para>Possible values: HidePasswords, ReadOnly, AllowPasswordsInWebPage</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">LockdownPolicy</command:parameterValue> <dev:type> <maml:name>LockdownPolicy</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>HidePasswords</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="6" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalStore</maml:name> </dev:type> <maml:description> <maml:para>The RoyalStore to which the new Royal TS/X document will be assigned. See also New-RoyalStore cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>A RoyalStore object is required for this cmdlet. Use the New-RoyalStore cmdlet to create one.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$doc = New-RoyalDocument -Store $store -Name "document name" -FileName $fileName</dev:code> <dev:remarks> <maml:para>This command only creates a new Royal TS/X document in memory. It does not save the document to disk until you use the Out-RoyalDocument cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$pwd = "document_password" | ConvertTo-SecureString -AsPlainText -Force $doc = New-RoyalDocument -Store $store -Name "document name" -FileName $fileName -Password $pwd</dev:code> <dev:remarks> <maml:para>This command only creates a new Royal TS/X document in memory. It does not save the document to disk until you use the Out-RoyalDocument cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>$pwd = "document_password" | ConvertTo-SecureString -AsPlainText -Force $ldpwd = "lockdown_password" | ConvertTo-SecureString -AsPlainText -Force [RoyalDocument.PowerShell.LockdownPolicy]$policy = [RoyalDocument.PowerShell.LockdownPolicy]::ReadOnly $policy += [RoyalDocument.PowerShell.LockdownPolicy]::HidePasswords $doc = New-RoyalDocument -Store $store -Name "document name" -FileName $fileName -Password $pwd -LockdownPassword $ldpwd -LockdownPolicy $policy</dev:code> <dev:remarks> <maml:para>This command only creates a new Royal TS/X document in memory. It does not save the document to disk until you use the Out-RoyalDocument cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalStore</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-RoyalObject</command:name> <command:verb>New</command:verb> <command:noun>RoyalObject</command:noun> <maml:description> <maml:para>Creates a new object in a document or folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to create folders, connections, tasks or credentials.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RoyalObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder or document where the new object should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies which type of object should be created.</maml:para> <maml:para>Possible values: RoyalFolder, RoyalDynamicFolder, RoyalCredential, RoyalDynamicCredential, RoyalToDo, RoyalRDSConnection, RoyalVNCConnection, RoyalSSHConnection, RoyalFileTransferConnection, RoyalWebConnection, RoyalTeamViewerConnection, RoyalAppConnection, RoyalPerformanceConnection, RoyalPowerShellConnection, RoyalWindowsEventsConnection, RoyalWindowsProcessesConnection, RoyalWindowsServicesConnection, RoyalTerminalServicesConnection, RoyalHyperVConnection, RoyalVMwareConnection, RoyalManagementEndpoint, RoyalSecureGateway, RoyalRDSGateway, RoyalCommandTask, RoyalKeySequenceTask, RoyalApplicationSetting</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">RoyalFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDynamicFolder</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalCredential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalDynamicCredential</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalToDo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalRDSConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalVNCConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalSSHConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalFileTransferConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWebConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalTeamViewerConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalAppConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalPerformanceConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalPowerShellConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsEventsConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsProcessesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalWindowsServicesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalTerminalServicesConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalHyperVConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalVMwareConnection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalManagementEndpoint</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalSecureGateway</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalRDSGateway</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalCommandTask</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalKeySequenceTask</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RoyalApplicationSetting</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectType</command:parameterValue> <dev:type> <maml:name>RoyalObjectType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new object.</maml:para> <maml:para>Specify an array of names to create multiple objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-RoyalObject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder or document where the new object should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>TypeString</maml:name> <maml:description> <maml:para>Specifies which type of object should be created by using a string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new object.</maml:para> <maml:para>Specify an array of names to create multiple objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder or document where the new object should be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies which type of object should be created.</maml:para> <maml:para>Possible values: RoyalFolder, RoyalDynamicFolder, RoyalCredential, RoyalDynamicCredential, RoyalToDo, RoyalRDSConnection, RoyalVNCConnection, RoyalSSHConnection, RoyalFileTransferConnection, RoyalWebConnection, RoyalTeamViewerConnection, RoyalAppConnection, RoyalPerformanceConnection, RoyalPowerShellConnection, RoyalWindowsEventsConnection, RoyalWindowsProcessesConnection, RoyalWindowsServicesConnection, RoyalTerminalServicesConnection, RoyalHyperVConnection, RoyalVMwareConnection, RoyalManagementEndpoint, RoyalSecureGateway, RoyalRDSGateway, RoyalCommandTask, RoyalKeySequenceTask, RoyalApplicationSetting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectType</command:parameterValue> <dev:type> <maml:name>RoyalObjectType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>TypeString</maml:name> <maml:description> <maml:para>Specifies which type of object should be created by using a string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new object.</maml:para> <maml:para>Specify an array of names to create multiple objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalFolder</maml:name> </dev:type> <maml:description> <maml:para>The folder or document where the new object should be added.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$cred = New-RoyalObject -folder $doc -Type RoyalCredential -Name "My new Credential" -Description "some description"</dev:code> <dev:remarks> <maml:para>The variable $doc is a RoyalDocument created with the New-RoyalDocument cmdlet or returned by the Open-Document cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-RoyalObjectCustomProperty</command:name> <command:verb>New</command:verb> <command:noun>RoyalObjectCustomProperty</command:noun> <maml:description> <maml:para>Creates a new custom property for an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new custom property for a given object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the custom property that should be created.</maml:para> <maml:para>Possible values: Header, Text, Protected, Address, Phone, Email, URL, YesNo, Date</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Header</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Text</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Protected</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Address</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Phone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Email</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">URL</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">YesNo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Date</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">CustomPropertyType</command:parameterValue> <dev:type> <maml:name>CustomPropertyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Header</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the custom property that should be created.</maml:para> <maml:para>Possible values: Header, Text, Protected, Address, Phone, Email, URL, YesNo, Date</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomPropertyType</command:parameterValue> <dev:type> <maml:name>CustomPropertyType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Header</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocument.PowerShell.RoyalObjectCmdLets.CustomProperty</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-RoyalObjectCustomProperty -Object $object -Type Text -Label "Text Label" -Value "New Value"</dev:code> <dev:remarks> <maml:para>This cmdlet creates a custom property for the object $object of type Text with the label and the value specified.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomPropertyPosition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-RoyalStore</command:name> <command:verb>New</command:verb> <command:noun>RoyalStore</command:noun> <maml:description> <maml:para>Creates a new RoyalStore container to open one or more Royal TS/X documents.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet creates a new RoyalStore in memory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RoyalStore</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppDocPath</maml:name> <maml:description> <maml:para>{{ Fill AppDocPath Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName1</maml:name> <maml:description> <maml:para>{{ Fill UserName1 Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AppDocPath</maml:name> <maml:description> <maml:para>{{ Fill AppDocPath Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName1</maml:name> <maml:description> <maml:para>{{ Fill UserName1 Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>The RoyalStore is the basic container that is needed when working with Royal TS/X documents (.rtsz files).</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$store = New-RoyalStore -UserName "username" $doc = New-RoyalDocument -Store $store -FileName doc.rtsz -Name "documentname" Write-Host ($row[0] + " - " + $row[1])</dev:code> <dev:remarks> <maml:para>The variable $store is used for New-RoyalDocument cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code># Pipe the RoyalStore to the New-RoyalDocument cmdlet $doc = New-RoyalStore -UserName "username" | New-RoyalDocument -FileName doc.rtsz -Name "documentname"</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Close-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-RoyalDocument</command:name> <command:verb>Open</command:verb> <command:noun>RoyalDocument</command:noun> <maml:description> <maml:para>Opens an existing Royal TS/X document (.rtsz file) from the filesystem.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet opens an existing Royal TS/X document from the filesystem.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RoyalDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore to which the specified Royal TS/X document will be assigned after it has been opened. See also New-RoyalStore cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name where the Royal TS/X document to open is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Royal TS/X document (if required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The lockdown password for the Royal TS/X document (if lockdown is configured and required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Store</maml:name> <maml:description> <maml:para>The RoyalStore to which the specified Royal TS/X document will be assigned after it has been opened. See also New-RoyalStore cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalStore</command:parameterValue> <dev:type> <maml:name>RoyalStore</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>The file name where the Royal TS/X document to open is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Royal TS/X document (if required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The lockdown password for the Royal TS/X document (if lockdown is configured and required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="4" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalStore</maml:name> </dev:type> <maml:description> <maml:para>The RoyalStore to which the specified Royal TS/X document will be assigned after it has been opened. See also New-RoyalStore cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>A RoyalStore object is required for this cmdlet. Use the New-RoyalStore cmdlet to create one.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$doc = Open-RoyalDocument -Store $store -FileName "f:\documents\document.rtsz" -Password (Read-Host -AsSecureString "Password")</dev:code> <dev:remarks> <maml:para>This command opens an existing Royal TS/X document specified in -FileName. If the -Interactive switch is specified, the cmdlet is asking for the password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$pwd = ConvertTo-SecureString "super-secure-pwd" -AsPlainText -Force $doc = Open-RoyalDocument -Store $store -FileName "f:\documents\document.rtsz" -Password $pwd</dev:code> <dev:remarks> <maml:para>In this example, the password is passed on to the cmdlet. Note: we do not recommend to put passwords of your Royal TS/X documents in your scripts!</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalStore</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Open-RoyalServerDocument</command:name> <command:verb>Open</command:verb> <command:noun>RoyalServerDocument</command:noun> <maml:description> <maml:para>Opens a Royal TS/X document (.rtsz file) from Royal Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet opens an existing Royal TS/X document from a Royal Server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Open-RoyalServerDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoyalServerDocument</maml:name> <maml:description> <maml:para>The Royal Server document to open (can be obtained using the Get-RoyalServerDocument cmdlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DocStoreEntry</command:parameterValue> <dev:type> <maml:name>DocStoreEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Royal TS/X document (if required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The lockdown password for the Royal TS/X document (if lockdown is configured and required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoyalServerDocument</maml:name> <maml:description> <maml:para>The Royal Server document to open (can be obtained using the Get-RoyalServerDocument cmdlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DocStoreEntry</command:parameterValue> <dev:type> <maml:name>DocStoreEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Password</maml:name> <maml:description> <maml:para>The password for the Royal TS/X document (if required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>LockdownPassword</maml:name> <maml:description> <maml:para>The lockdown password for the Royal TS/X document (if lockdown is configured and required).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="5" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalManagementEndpoint</maml:name> </dev:type> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para>If specified, the password will be prompted (the password parameter is ignored).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$doc = Open-RoyalServerDocument -RoyalServer $server -RoyalServerDocument $serverDocument</dev:code> <dev:remarks> <maml:para>This command opens an existing Royal TS/X document from the specified Royal Server. The RoyalServerDocument parameter can be set with an object from Get-RoyalServerDocument cmdlet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Close-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-RoyalDocument</command:name> <command:verb>Out</command:verb> <command:noun>RoyalDocument</command:noun> <maml:description> <maml:para>Saves a Royal TS/X document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet saves a Royal TS/X document (.rtsz file)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-RoyalDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>If specified, this parameter will be used for saving to disk. This will also update the $document.FileName property to the new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>If specified, this parameter will be used for saving to disk. This will also update the $document.FileName property to the new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Out-RoyalDocument -FileName "royaltsdocument.rtsz" -Document $doc</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-RoyalServerDocument</command:name> <command:verb>Out</command:verb> <command:noun>RoyalServerDocument</command:noun> <maml:description> <maml:para>Saves a Royal TS/X document to a Royal Server.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet saves a Royal TS/X document to a Royal Server</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-RoyalServerDocument</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RoyalServerDocument</maml:name> <maml:description> <maml:para>The Royal Server document to open (can be obtained using the Get-RoyalServerDocument cmdlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DocStoreEntry</command:parameterValue> <dev:type> <maml:name>DocStoreEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RoyalServer</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalManagementEndpoint</command:parameterValue> <dev:type> <maml:name>RoyalManagementEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RoyalServerDocument</maml:name> <maml:description> <maml:para>The Royal Server document to open (can be obtained using the Get-RoyalServerDocument cmdlet).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DocStoreEntry</command:parameterValue> <dev:type> <maml:name>DocStoreEntry</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>IgnoreCertificateWarning</maml:name> <maml:description> <maml:para>The Royal Server to connect to and retrieve the list of documents.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document that will be saved to disk.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Out-RoyalServerDocument -Document $doc -RoyalServer $server -RoyalServerDocument $serverDocument</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalServerDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-RoyalObject</command:name> <command:verb>Remove</command:verb> <command:noun>RoyalObject</command:noun> <maml:description> <maml:para>Removes an object from the document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes an object from the document.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RoyalObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force removes the object immediately (the object will not be in the Trashcan).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object that is going to be removed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Using Force removes the object immediately (the object will not be in the Trashcan).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object that is going to be removed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-RoyalObject -Object $folder -Force</dev:code> <dev:remarks> <maml:para>This command deletes $folder (including all containing objects of that folder) from the document. Since the parameter -Force is used, the object is NOT kept in the internal Trashcan.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-RoyalObjectCustomProperty</command:name> <command:verb>Remove</command:verb> <command:noun>RoyalObjectCustomProperty</command:noun> <maml:description> <maml:para>Removes a custom property from an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet removes a custom property from a given object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocument.PowerShell.RoyalObjectCmdLets.CustomProperty</maml:name> </dev:type> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Remove-RoyalObjectCustomProperty -Object $object -Id $propertyId</dev:code> <dev:remarks> <maml:para>This cmdlet removes the custom property with the given id from $object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Remove-RoyalObjectCustomProperty -CustomProperty $customProperty</dev:code> <dev:remarks> <maml:para>This cmdlet removes the custom property (use Get-RoyalObjectCustomProperty to retrieve custom property objects).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomPropertyPosition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalDocumentPassword</command:name> <command:verb>Set</command:verb> <command:noun>RoyalDocumentPassword</command:noun> <maml:description> <maml:para>Sets the password of a Royal TS/X document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet allows you to set or change the password of a Royal TS/X document.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalDocumentPassword</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document to change the password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password for the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>OldPassword</maml:name> <maml:description> <maml:para>The old password of the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The Royal TS/X document to change the password.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NewPassword</maml:name> <maml:description> <maml:para>The new password for the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>OldPassword</maml:name> <maml:description> <maml:para>The old password of the document.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The Royal TS/X document to change the password.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> <maml:description> <maml:para>If specified, the password will be prompted (the password parameters are ignored).</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalDocumentPassword -Document $document -OldPassword $oldPwd -Password $newPwd -Interactive</dev:code> <dev:remarks> <maml:para>$oldPwd and $newPwd are SecureStrings. Use (Read-Host -AsSecureString "Password") or ConvertTo-SecureString. If the -Interactive switch is specified, the cmdlet is asking for the password.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalDocumentType</command:name> <command:verb>Set</command:verb> <command:noun>RoyalDocumentType</command:noun> <maml:description> <maml:para>Sets the type of the Royal TS/X document.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets the document type to Merge (merges all changes from the in-memory RoyalDocument back to the version saved to disk) or OverWrite (overwrites the version on disk).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalDocumentType</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The RoyalDocument of which the document type should be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The new document type (Merge or OverWrite).</maml:para> <maml:para>Possible values: OverWrite, Merge</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">OverWrite</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Merge</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalDocumentType</command:parameterValue> <dev:type> <maml:name>RoyalDocumentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Document</maml:name> <maml:description> <maml:para>The RoyalDocument of which the document type should be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocument</command:parameterValue> <dev:type> <maml:name>RoyalDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The new document type (Merge or OverWrite).</maml:para> <maml:para>Possible values: OverWrite, Merge</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalDocumentType</command:parameterValue> <dev:type> <maml:name>RoyalDocumentType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalDocument</maml:name> </dev:type> <maml:description> <maml:para>The RoyalDocument of which the document type should be changed.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalDocumentType -Document $document -Type Merge</dev:code> <dev:remarks> <maml:para>This cmdlete only changes the RoyalDocumentType in memory - for persisting call Out-RoyalDocument.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-RoyalDocumentType</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Open-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Out-RoyalDocument</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalObjectCustomProperty</command:name> <command:verb>Set</command:verb> <command:noun>RoyalObjectCustomProperty</command:noun> <maml:description> <maml:para>Sets a custom property value on an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets a custom property value for a given object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RoyalObjectCustomProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Label</maml:name> <maml:description> <maml:para>The label of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The value of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocument.PowerShell.RoyalObjectCmdLets.CustomProperty</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalObjectCustomProperty -Object $object -Id $propertyId -Label "New Label" -Value "New Value"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the label and the value of the custom property with the given id from $object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-RoyalObjectCustomProperty -CustomProperty $customProperty -Value "New Value"</dev:code> <dev:remarks> <maml:para>This cmdlet sets the value of the given custom property (use Get-RoyalObjectCustomProperty to retrieve custom property objects).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomPropertyPosition</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalObjectCustomPropertyPosition</command:name> <command:verb>Set</command:verb> <command:noun>RoyalObjectCustomPropertyPosition</command:noun> <maml:description> <maml:para>Sets the position for a custom property on an object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets the position of a custom property for a given object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalObjectCustomPropertyPosition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-RoyalObjectCustomPropertyPosition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the custom property that should be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CustomProperty</maml:name> <maml:description> <maml:para>The custom property object used to set the label and value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">CustomProperty</command:parameterValue> <dev:type> <maml:name>CustomProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Position</maml:name> <maml:description> <maml:para>The position of the custom property.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Indicates that this cmdlet returns a custom property object. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object with the custom properties.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocument.PowerShell.RoyalObjectCmdLets.CustomProperty</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalObjectCustomPropertyPosition -Object $object -Id $propertyId -Position 3</dev:code> <dev:remarks> <maml:para>This cmdlet sets the custom property position to the 3rd entry for the given $object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Set-RoyalObjectCustomProperty -CustomProperty $customProperty -Position 3</dev:code> <dev:remarks> <maml:para>This cmdlet sets the custom property position to the 3rd entry for the given $object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectCustomProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalObjectValue</command:name> <command:verb>Set</command:verb> <command:noun>RoyalObjectValue</command:noun> <maml:description> <maml:para>Sets the value of an object's property.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sets an object's property value. A new value can only be set if the type of the value parameter matches (or can be casted) to the type of the parameter Property.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalObjectValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object on which the new value should be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>The object's property name that should be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>The object on which the new value should be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalBase</command:parameterValue> <dev:type> <maml:name>RoyalBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:description> <maml:para>The object's property name that should be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalBase</maml:name> </dev:type> <maml:description> <maml:para>The object on which the new value should be set.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalObjectValue -Object $folder -Property "Created" -Value $dt</dev:code> <dev:remarks> <maml:para>$dt is of Type System.DateTime.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-RoyalSortOrder</command:name> <command:verb>Set</command:verb> <command:noun>RoyalSortOrder</command:noun> <maml:description> <maml:para>Applies a sort order to a folder.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet sorts all objects in a folder based on the provided sort criteria. Up to three levels of sort criterias are supported. Additionally the sorting can be specified to be applied recursively to the folder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RoyalSortOrder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder (or document) that is going to be sorted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Criteria1</maml:name> <maml:description> <maml:para>The first sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreationDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ModifiedDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField9</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField10</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>SortDirection1</maml:name> <maml:description> <maml:para>The first sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Criteria2</maml:name> <maml:description> <maml:para>The second sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreationDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ModifiedDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField9</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField10</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SortDirection2</maml:name> <maml:description> <maml:para>The second sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Criteria3</maml:name> <maml:description> <maml:para>The third sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Name</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreationDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ModifiedDate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField1</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField2</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField3</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField4</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField5</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField6</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField7</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField8</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField9</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CustomField10</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>SortDirection3</maml:name> <maml:description> <maml:para>The third sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Ascending</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Descending</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Defines if the sorting should be applied recursively.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Folder</maml:name> <maml:description> <maml:para>The folder (or document) that is going to be sorted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalFolder</command:parameterValue> <dev:type> <maml:name>RoyalFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Criteria1</maml:name> <maml:description> <maml:para>The first sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>SortDirection1</maml:name> <maml:description> <maml:para>The first sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Criteria2</maml:name> <maml:description> <maml:para>The second sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SortDirection2</maml:name> <maml:description> <maml:para>The second sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Criteria3</maml:name> <maml:description> <maml:para>The third sort criteria.</maml:para> <maml:para>Possible values: None, Name, ObjectType, CreationDate, ModifiedDate, CustomField1, CustomField2, CustomField3, CustomField4, CustomField5, CustomField6, CustomField7, CustomField8, CustomField9, CustomField10</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortCriteria</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortCriteria</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>SortDirection3</maml:name> <maml:description> <maml:para>The third sort direction criteria.</maml:para> <maml:para>Possible values: Ascending, Descending</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RoyalObjectSortDirection</command:parameterValue> <dev:type> <maml:name>RoyalObjectSortDirection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>Defines if the sorting should be applied recursively.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalFolder</maml:name> </dev:type> <maml:description> <maml:para>The folder (or document) that is going to be sorted.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RoyalDocumentLibrary.RoyalFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Set-RoyalSortOrder -Criteria1 Name -SortDirection1 Ascending -Folder $doc</dev:code> <dev:remarks> <maml:para>This cmdlet applies the sort criteria to the specified folder.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>New-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Move-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Copy-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObjectValue</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-RoyalObject</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |