posh-kentico.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>posh-kentico</name> </assembly> <members> <member name="T:PoshKentico.Helpers.CmsApplicationHelper"> <summary> Used to initialize Kentico CMS applications. </summary> </member> <member name="M:PoshKentico.Helpers.CmsApplicationHelper.FindKenticoSite(System.String@,System.Action{System.String},System.Action{System.String})"> <summary> This method requires administrator access. Finds a Kentico website by performing the following steps: 1. Get a list of all the sites from IIS 2. Get a list of all applications from the sites 3. Get a list of all the virtual directories from the applications 4. Continue processing virtual directory if a web.config file exits 5. Parse the document and find an "add" node with name="CMSConnectionString" 6. If the connection string is valid, then stop processing. This is a Kentico site. </summary> <param name="connectionString">Output parameter containing the connection string of the Kentico site.</param> <param name="writeDebug">A delegate for writing to the debug stream.</param> <param name="writeVerbose">A delegate for writing to the verbose stream.</param> <returns>The directory for the Kentico site.</returns> </member> <member name="M:PoshKentico.Helpers.CmsApplicationHelper.InitializeKentico(System.Action{System.String},System.Action{System.String})"> <summary> Initialize Kentico CMS Application using FindKenticoSite to locate the site. </summary> <param name="writeDebug">A delegate for writing to the debug stream.</param> <param name="writeVerbose">A delegate for writing to the verbose stream.</param> </member> <member name="M:PoshKentico.Helpers.CmsApplicationHelper.InitializeKentico(System.String,System.IO.DirectoryInfo,System.Action{System.String},System.Action{System.String})"> <summary> Initialize Kentico CMS Application using the supplied parameters. </summary> <param name="connectionString">The connection string to use for initializing the CMS Application.</param> <param name="directoryInfo">The directory where the Kentico site resides.</param> <param name="writeDebug">A delegate for writing to the debug stream.</param> <param name="writeVerbose">A delegate for writing to the verbose stream.</param> </member> <member name="T:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter"> <summary> Dynamic parameter used for New-Item -ItemType WebPartCategory </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter.DisplayName"> <summary> <para type="description">The display name for the webpart category.</para> </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartCategoryDynamicParameter.ImagePath"> <summary> <para type="description">The image to display for the webpart category.</para> </summary> </member> <member name="T:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter"> <summary> Dynamic parameter used for New-Item -ItemType WebPart </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter.DisplayName"> <summary> <para type="description">The display name for the webpart.</para> </summary> </member> <member name="P:PoshKentico.Navigation.DynamicParameters.NewWebPartDynamicParameter.FileName"> <summary> <para type="description">The file name for the webpart.</para> </summary> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem"> <summary> Base class for FileSystemItems. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.#ctor(PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem"/> class. </summary> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Item"> <summary> Gets the item that the file system item represents. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Name"> <summary> Gets the name of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Parent"> <summary> Gets the parent of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.DeleteChildren"> <summary> Deletes all children. </summary> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="path">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.GetItemsFromRegex(System.Text.RegularExpressions.Regex)"> <summary> Finds the file system item representing the path specified. </summary> <param name="regex">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.AbstractFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item under the current path. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem"> <summary> The root file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.#ctor"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem"/> class. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Item"> <summary> Gets the parent of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="path">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.RootFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> This method is not supported. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"> <summary> File system item representing a <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.#ctor(CMS.PortalEngine.WebPartCategoryInfo,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"/> class. </summary> <param name="webPartCategoryInfo">The <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/> for the file system to represent.</param> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Item"> <summary> Gets the item that the file system item represents. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Create(System.String,System.String,System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Creates a new <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/> under the specified parent. </summary> <param name="displayName">Display name for the new <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>.</param> <param name="name">Name for the <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/>.</param> <param name="imagePath">Image Path for the <see cref="T:CMS.PortalEngine.WebPartCategoryInfo"/></param> <param name="parent">The parent of type <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem"/>.</param> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="path">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartCategoryFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item under the current path. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"> <summary> Interface for FileSystemItems. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Item"> <summary> Gets the item that the file system item represents. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Name"> <summary> Gets the name of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Parent"> <summary> Gets the parent of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="regex">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.GetItemsFromRegex(System.Text.RegularExpressions.Regex)"> <summary> Gets a list of items under this item that matches the specified regex. </summary> <param name="regex">Regular expression to match.</param> <returns>An array of file system items matching the specified regular expression.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.IFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item under the current path. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"> <summary> File system item representing a <see cref="T:CMS.PortalEngine.WebPartInfo"/>. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.#ctor(CMS.PortalEngine.WebPartInfo,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"/> class. </summary> <param name="webPartInfo">The <see cref="T:CMS.PortalEngine.WebPartInfo"/> for the file system to represent.</param> <param name="parent">The parent file system item. Null if root.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Item"> <summary> Gets the item that the file system item represents. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Create(System.String,System.String,System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem)"> <summary> Creates a new <see cref="T:CMS.PortalEngine.WebPartInfo"/> under the specified parent. </summary> <param name="displayName">Display name for the new <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="name">Name for the <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="fileName">File name for the new <see cref="T:CMS.PortalEngine.WebPartInfo"/>.</param> <param name="parent">The parent of type <see cref="T:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem"/>.</param> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="path">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.WebPartFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> This method is not supported. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"> <summary> File system item which represents items that are not actually part of Kentico. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.#ctor(System.String,PoshKentico.Navigation.FileSystemItems.IFileSystemItem,System.Collections.Generic.IEnumerable{PoshKentico.Navigation.FileSystemItems.IFileSystemItem})"> <summary> Initializes a new instance of the <see cref="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"/> class. </summary> <param name="path">The path for the current <see cref="T:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem"/>.</param> <param name="parent">The parent <see cref="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"/>.</param> <param name="children">The children <see cref="T:PoshKentico.Navigation.FileSystemItems.IFileSystemItem"/>s.</param> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Children"> <summary> Gets the Children of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.IsContainer"> <summary> Gets if the file system item is a container </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Item"> <summary> Gets the parent of the file system item. </summary> </member> <member name="P:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Path"> <summary> Gets the full path of the file system item. </summary> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Delete(System.Boolean)"> <summary> Deletes the file system item. </summary> <param name="recurse">Indicates if the delete function should delete children.</param> <returns>True if successful, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.Exists(System.String)"> <summary> Checks if the path specified exists. </summary> <param name="path">File system path to check.</param> <returns>True if exists, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.FindPath(System.String)"> <summary> Finds the file system item representing the path specified. </summary> <param name="path">File system path to find.</param> <returns>The file system item representing the path specified. Null if not found.</returns> </member> <member name="M:PoshKentico.Navigation.FileSystemItems.MetaFileSystemItem.NewItem(System.String,System.String,System.Object)"> <summary> This method is not supported. </summary> <param name="name">Name of the new item.</param> <param name="itemTypeName">Type of the new item. Specified as the -ItemType parameter.</param> <param name="newItemValue">Either the dynamic parameter or the value specified on the -Value parameter.</param> </member> <member name="T:PoshKentico.Navigation.KenticoNavigationCmdletProvider"> <summary> Kentico CMS file system provider for PowerShell. Creates Kentico: by default. </summary> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ExpandPath(System.String)"> <summary> Expands the path specified. </summary> <param name="path">The file system path to exand.</param> <returns>An array representing the expanded paths.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.IsValidPath(System.String)"> <summary> Indicates if the path specified is valid. </summary> <param name="path">The file system path to check.</param> <returns>True if the path is valid, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.InitializeDefaultDrives"> <summary> Creates default drives. Creates a Kentico: drive. </summary> <returns>A collection of the drives created.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.ItemExists(System.String)"> <summary> Checks if an item exists at the specified path. </summary> <param name="path">The file system path to check.</param> <returns>True if the item exists at the specified path, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.IsItemContainer(System.String)"> <summary> Checks if the item is a container (directory). </summary> <param name="path">The file system path to check.</param> <returns>True if the item at the specified path is a container, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetChildItems(System.String,System.Boolean)"> <summary> Gets all of the child items at the specified path. </summary> <param name="path">The file system path to get the child items of.</param> <param name="recurse">Indicates if we should iterate through all children recursively.</param> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.GetItem(System.String)"> <summary> Gets the item at the specified path. </summary> <param name="path">The file system path to the item to get.</param> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.HasChildItems(System.String)"> <summary> Indicates whether the item at the specified path has any children. </summary> <param name="path">The file system path to the item to check for children.</param> <returns>True if the specified item has any children, false otherwise.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NewItem(System.String,System.String,System.Object)"> <summary> Creates a new item at the specified path. </summary> <param name="path">The file system path to create the new item at.</param> <param name="itemTypeName">The value specified to the -ItemType parameter.</param> <param name="newItemValue">The value of the item to create at the specified location.</param> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NewItemDynamicParameters(System.String,System.String,System.Object)"> <summary> Creates a new dynamic parameter for New-Item. </summary> <param name="path">The file system path to create the new item at.</param> <param name="itemTypeName">The value specified to the -ItemType parameter.</param> <param name="newItemValue">The value of the item to create at the specified location.</param> <returns>The new dynamic parameter for the specified item type.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.NormalizeRelativePath(System.String,System.String)"> <summary> Normalizes the specified path to an item, returning a path relative to a specified base path. </summary> <param name="path">A fully-qualified provider specific path to an item.</param> <param name="basePath">The path that the return value is relative to.</param> <returns>A normalized path that is relative to the specified base path.</returns> </member> <member name="M:PoshKentico.Navigation.KenticoNavigationCmdletProvider.RemoveItem(System.String,System.Boolean)"> <summary> Removes the item at the specified path. </summary> <param name="path">The file system path to the item to remove.</param> <param name="recurse">Indicates if children items should be removed.</param> </member> <member name="T:PoshKentico.General.InitializeCMSApplication"> <summary> <para type="synopsis">Initializes a connection to the Kentico CMS Server.</para> <para type="description">The Initialize-CMSApplication cmdlet initializes a connection to the Kentico CMS server.</para> <para type="description"></para> <para type="description">If this cmdlet is run without parameters, then it requires administrator permissions to find the Kentico site.</para> <para type="description">It does so by performing the following steps:</para> <para type="description">1. Get a list of all the sites from IIS</para> <para type="description">2. Get a list of all applications from the sites</para> <para type="description">3. Get a list of all the virtual directories from the applications</para> <para type="description">4. Continue processing virtual directory if a web.config file exits</para> <para type="description">5. Parse the document and find an "add" node with name="CMSConnectionString"</para> <para type="description">6. If the connection string is valid, then stop processing</para> <example> <para>Initialize the Kentico CMS Application by searching for the Kentico site.</para> <para>This option requires administrator rights.</para> <code>Initialize-CMSApplication</code> </example> <example> <para>Initialize the Kentico CMS Application by using the specified connection string.</para> <para>This option does not require administrator rights.</para> <code>Initialize-CMSApplication -DatabaseServer KenticoServer -Database Kentico -WebRoot C:\kentico</code> </example> </summary> </member> <member name="P:PoshKentico.General.InitializeCMSApplication.ConnectionString"> <summary> <para type="description">The connection string for the database connection.</para> </summary> </member> <member name="P:PoshKentico.General.InitializeCMSApplication.DatabaseServer"> <summary> <para type="description">The database server to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.General.InitializeCMSApplication.Database"> <summary> <para type="description">The database to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.General.InitializeCMSApplication.Timeout"> <summary> <para type="description">The timeout to use for generating the connection string.</para> </summary> </member> <member name="P:PoshKentico.General.InitializeCMSApplication.WebRoot"> <summary> <para type="description">The root directory for the Kentico site.</para> </summary> </member> <member name="M:PoshKentico.General.InitializeCMSApplication.BeginProcessing"> <summary> Begin processing of records. </summary> </member> </members> </doc> |