SymphonyElectron/installer/win/WixSharpToolset/WixSharp.Lab.xml
2020-08-21 08:25:55 +02:00

665 lines
26 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>WixSharp.Lab</name>
</assembly>
<members>
<member name="T:WixSharp.Controls.Extensions">
<summary>
Generic extension methods for <see cref="N:WixSharp.Controls"/>
</summary>
</member>
<member name="M:WixSharp.Controls.Extensions.CopyCommonPropertiesFrom(WixSharp.Controls.Control,WixSharp.Controls.IWixControl)">
<summary>
Copies the common properties from one <see cref="T:WixSharp.Controls.IWixControl"/> to another.
</summary>
<param name="destControl">The dest control.</param>
<param name="srcControl">The source control.</param>
</member>
<member name="M:WixSharp.Controls.Extensions.ConvertToWControl(WixSharp.Controls.IWixControl,WixSharp.Controls.ControlType)">
<summary>
Converts <see cref="T:WixSharp.Controls.IWixControl"/> into an instance of <see cref="T:WixSharp.Controls.Control"/>.
</summary>
<param name="srcControl">The source control.</param>
<param name="controlType">Type of the control.</param>
<returns></returns>
</member>
<member name="F:WixSharp.Controls.Extensions.WixScalingFactor">
<summary>
The WiX UI scaling factor.
WiX pixels are not the same as Windows ones. For example Wix.Point(56,17) is equivalent of the Win.Point(75,23)
</summary>
</member>
<member name="M:WixSharp.Controls.Extensions.WScale(System.Int32)">
<summary>
Converts (scales) Windows coordinate value into WiX one.
</summary>
<param name="data">The data.</param>
<returns></returns>
</member>
<member name="T:WixSharp.Controls.WixButton">
<summary>
Defines <see cref="T:System.Windows.Forms" /> button control for generating WiX Button element.
<para>
The <see cref="T:WixSharp.WixButton" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixButton" /> instance at compile time
to generate WiX Button element on the base of this instance properties.
</para>
</summary>
</member>
<member name="P:WixSharp.Controls.WixButton.Conditions">
<summary>
Gets or sets the control conditions.
</summary>
<value>
The control conditions.
</value>
</member>
<member name="M:WixSharp.Controls.WixButton.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixButton"/> class.
</summary>
</member>
<member name="P:WixSharp.Controls.WixButton.WixSize">
<summary>
Gets the size of the <c>Control</c>.
</summary>
<value>
The size of the <c>Control</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.WixLocation">
<summary>
Gets the <c>Control</c> location.
</summary>
<value>
The <c>Control</c> location.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.Actions">
<summary>
Gets the actions associated with the WiX <c>Control</c>.
</summary>
<value>
The actions.
</value>
</member>
<member name="E:WixSharp.Controls.WixButton.Click">
<summary>
Occurs when <see cref="T:WixSharp.Compiler" /> triggers it in order to generate WiX XML
for the control action(s).
</summary>
</member>
<member name="M:WixSharp.Controls.WixButton.PerformClick">
<summary>
Generates a <see cref="T:System.Windows.Forms.Control.Click" /> event for a button.
</summary>
<remarks>Because WixSharp UI controls are used only at compile time to generate WiX actions XML the events are raised/triggered by
the <see cref="T:WixSharp.Compiler"/> but not by the user at runtime (deployment time).
</remarks>
</member>
<member name="P:WixSharp.Controls.WixButton.Id">
<summary>
Gets or sets the <c>Control</c> Id.
</summary>
<value>
The Id.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.Tooltip">
<summary>
Gets or sets the <c>Control</c> tooltip.
</summary>
<value>
The tooltip.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.BoundProperty">
<summary>
Gets or sets the bound property name.
</summary>
<value>
The bound property name.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.Hidden">
<summary>
Gets or sets a value indicating whether this <see cref="T:WixSharp.Controls.IWixControl" /> is hidden.
</summary>
<value>
<c>true</c> if hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixButton.WixAttributes">
<summary>
Gets or sets the WiX attributes.
</summary>
<value>
The WiX attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixButton.ToWControl">
<summary>
Converts the WinForm control into WiX custom UI control <see cref="T:WixSharp.Control" />.
</summary>
<returns>
Instance of the WixSharp.Control.
</returns>
</member>
<member name="T:WixSharp.Controls.WixCheckBox">
<summary>
Defines <see cref="T:System.Windows.Forms" /> CheckBox control for generating WiX Button element.
<para>
The <see cref="T:WixSharp.WixButton" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixCheckBox" /> instance at compile time
to generate WiX CheckBox element on the base of this instance properties.
</para>
</summary>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.Conditions">
<summary>
Gets or sets the control conditions.
</summary>
<value>
The control conditions.
</value>
</member>
<member name="M:WixSharp.Controls.WixCheckBox.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixCheckBox"/> class.
</summary>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.WixSize">
<summary>
Gets the size of the CheckBox.
</summary>
<value>
The size of the CheckBox.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.WixLocation">
<summary>
Gets the CheckBox location.
</summary>
<value>
The CheckBox location.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.Id">
<summary>
Gets or sets the CheckBox Id.
</summary>
<value>
The CheckBox Id.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.Tooltip">
<summary>
Gets or sets the tooltip.
</summary>
<value>
The tooltip.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.CheckBoxValue">
<summary>
Gets or sets the CheckBox value.
</summary>
<value>
The CheckBox value.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.BoundProperty">
<summary>
Gets or sets the bound property name.
</summary>
<value>
The bound property name.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.Hidden">
<summary>
Gets or sets a value indicating whether this <see cref="T:WixSharp.Controls.IWixControl" /> is hidden.
</summary>
<value>
<c>true</c> if hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixCheckBox.WixAttributes">
<summary>
Gets or sets the WiX attributes.
</summary>
<value>
The WiX attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixCheckBox.ToWControl">
<summary>
Converts the WinForm control into WiX custom UI control <see cref="T:WixSharp.Control" />.
</summary>
<returns>
Instance of the WixSharp.Control.
</returns>
<exception cref="T:System.ApplicationException">WixCheckBox (' + control.Id + ') must have BoundProperty set to non-empty value.</exception>
</member>
<member name="T:WixSharp.Controls.WixControl">
<summary>
Defines <see cref="T:System.Windows.Forms" /> generic control for generating WiX Control element.
<para>
The <see cref="T:WixSharp.WixControl" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixControl" /> instance at compile time
to generate WiX Control element on the base of this instance properties.
</para>
</summary>
</member>
<member name="P:WixSharp.Controls.WixControl.Conditions">
<summary>
Gets or sets the control conditions.
</summary>
<value>
The control conditions.
</value>
</member>
<member name="M:WixSharp.Controls.WixControl.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixControl"/> class.
</summary>
</member>
<member name="E:WixSharp.Controls.WixControl.Click">
<summary>
Occurs when <see cref="T:WixSharp.Compiler" /> triggers it in order to generate WiX XML
for the control action(s).
</summary>
</member>
<member name="P:WixSharp.Controls.WixControl.Actions">
<summary>
Gets the actions associated with the WiX <c>Control</c>.
</summary>
<value>
The actions.
</value>
</member>
<member name="M:WixSharp.Controls.WixControl.PerformClick">
<summary>
Triggers <c>Click</c> event.
</summary>
</member>
<member name="P:WixSharp.Controls.WixControl.WixSize">
<summary>
Gets the size of the <c>Control</c>.
</summary>
<value>
The size of the <c>Control</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.WixLocation">
<summary>
Gets the WiX <c>Control</c> location.
</summary>
<value>
The location.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.Id">
<summary>
Gets or sets the <c>Control</c> Id.
</summary>
<value>
The Id.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.WixText">
<summary>
Gets or sets the text to be displayed by the <c>Control</c>.
</summary>
<value>
The text.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.Tooltip">
<summary>
Gets or sets the tooltip.
</summary>
<value>
The tooltip.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.BoundProperty">
<summary>
Gets or sets the bound property name.
</summary>
<value>
The bound property name.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.EmbeddedXML">
<summary>
Gets or sets the raw XML to be embedded into WiX <c>Control</c> element.
</summary>
<value>
The embedded XML.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.ControlType">
<summary>
Gets or sets the type of the control.
</summary>
<value>
The type of the control.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.Hidden">
<summary>
Gets or sets a value indicating whether this <see cref="T:WixSharp.Controls.IWixControl" /> is hidden.
</summary>
<value>
<c>true</c> if hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixControl.WixAttributes">
<summary>
Gets or sets the WiX element attributes.
</summary>
<value>
The WiX element attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixControl.ToWControl">
<summary>
Converts the WinForm control into WiX custom UI control <see cref="T:WixSharp.Control" />.
</summary>
<returns>
Instance of the WixSharp.Control.
</returns>
</member>
<member name="T:WixSharp.Controls.WixControlDesigner`1">
<summary>
Implements Form Designer support for the WixSharp MSI UI controls.
</summary>
<typeparam name="T">WinForm control to be supported by Form Designer.</typeparam>
</member>
<member name="F:WixSharp.Controls.WixControlDesigner`1.VisibleBaseProperties">
<summary>
The ';' separated list of the <see cref="T:System.Windows.Forms.Control" /> properties
to be visible in the properties grid by default.
</summary>
</member>
<member name="M:WixSharp.Controls.WixControlDesigner`1.PreFilterProperties(System.Collections.IDictionary)">
<summary>
Adjusts the set of properties the component exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.
</summary>
<param name="properties">An <see cref="T:System.Collections.IDictionary" /> containing the properties for the class of the component.</param>
</member>
<member name="M:WixSharp.Controls.WixControlDesigner`1.PreFilterEvents(System.Collections.IDictionary)">
<summary>
Allows a designer to add to the set of events that it exposes through a <see cref="T:System.ComponentModel.TypeDescriptor" />.
</summary>
<param name="events">The events for the class of the component.</param>
</member>
<member name="T:WixSharp.Controls.WixForm">
<summary>
Defines <see cref="T:System.Windows.Forms" /> Form for generating WiX Dialog element.
<para>
The <see cref="T:WixSharp.WixForm" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixForm" /> instance at compile time
to generate WiX Dialog element on the base of this instance properties.
</para>
</summary>
</member>
<member name="F:WixSharp.Controls.WixForm.dialogActions">
<summary>
The dialog actions
</summary>
</member>
<member name="M:WixSharp.Controls.WixForm.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixForm"/> class.
</summary>
</member>
<member name="P:WixSharp.Controls.WixForm.WixSize">
<summary>
Gets the size of the <c>Control</c>.
</summary>
<value>
The size of the <c>Control</c>.
</value>
</member>
<member name="M:WixSharp.Controls.WixForm.Do(System.String,System.String,System.String,System.String)">
<summary>
Generates and adds the action to the list of the dialog actions, which is to be used at compile time for
generating WiX Dialog element actions.
<code>
void wixButton_Click()
{
this.Do(ControlAction.DoAction, "ClaimLicenceKey");
}
</code>
</summary>
<param name="action">The action type.</param>
<param name="value">The action value.</param>
<param name="property">The property name.</param>
<param name="condition">The action condition.</param>
</member>
<member name="M:WixSharp.Controls.WixForm.EndDialog(System.String,System.String)">
<summary>
Generates and adds the EndDialog action to the list of the dialog actions, which is to be used at compile time for
generating WiX Dialog element actions.
<code>
void wixButton_Click()
{
this.EndDialog(EndDialogValue.Return);
}
</code>
</summary>
<param name="value">The action value.</param>
<param name="condition">The action condition.</param>
</member>
<member name="M:WixSharp.Controls.WixForm.SetProperty(System.String,System.String,System.String)">
<summary>
Generates and adds the SetProperty action to the list of the dialog actions, which is to be used at compile time for
generating WiX Dialog element actions.
</summary>
<param name="name">The property name.</param>
<param name="value">The property value.</param>
<param name="condition">The action condition.</param>
</member>
<member name="P:WixSharp.Controls.WixForm.Id">
<summary>
Gets or sets the id.
</summary>
<value>
The id.
</value>
</member>
<member name="P:WixSharp.Controls.WixForm.WixAttributes">
<summary>
Gets or sets the WiX element attributes.
</summary>
<value>
The WiX element attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixForm.ToWDialog">
<summary>
Converts the WixForm (WinForm) instance into WiX custom UI control WixSharp.<see cref="T:WixSharp.Dialog"/>.
</summary>
<returns>WixSharp.<see cref="T:WixSharp.Dialog"/> instance.</returns>
</member>
<member name="T:WixSharp.Controls.WixLabel">
<summary>
Defines <see cref="T:System.Windows.Forms" /> label control for generating WiX Label element.
<para>
The <see cref="T:WixSharp.WixLabel" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixLabel" /> instance at compile time
to generate WiX Label element on the base of this instance properties.
</para>
</summary>
</member>
<member name="P:WixSharp.Controls.WixLabel.Conditions">
<summary>
Gets or sets the control conditions.
</summary>
<value>
The control conditions.
</value>
</member>
<member name="M:WixSharp.Controls.WixLabel.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixLabel"/> class.
</summary>
</member>
<member name="P:WixSharp.Controls.WixLabel.WixSize">
<summary>
Gets the size of the <c>Control</c>.
</summary>
<value>
The size of the <c>Control</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.WixLocation">
<summary>
Gets the <c>Control</c> location.
</summary>
<value>
The <c>Control</c> location.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.Id">
<summary>
Gets or sets the Id.
</summary>
<value>
The Id.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.Tooltip">
<summary>
Gets or sets the tooltip.
</summary>
<value>
The tooltip.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.BoundProperty">
<summary>
Gets or sets the bound property name.
</summary>
<value>
The bound property name.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.Hidden">
<summary>
Gets or sets a value indicating whether this <see cref="T:WixSharp.Controls.IWixControl" /> is hidden.
</summary>
<value>
<c>true</c> if hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixLabel.WixAttributes">
<summary>
Gets or sets the WiX element attributes.
</summary>
<value>
The WiX element attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixLabel.ToWControl">
<summary>
Converts the WinForm control into WiX custom UI control <see cref="T:WixSharp.Control" />.
</summary>
<returns>
Instance of the WixSharp.Control.
</returns>
</member>
<member name="T:WixSharp.Controls.WixTextBox">
<summary>
Defines <see cref="T:System.Windows.Forms" /> text box control for generating WiX TextBox element.
<para>
The <see cref="T:WixSharp.WixTextBox" /> can be used with the <see cref="T:System.Windows.Forms" /> designer to define custom
dialog layouts. The <see cref="T:WixSharp.Compiler" /> uses <see cref="T:WixSharp.WixTextBox" /> instance at compile time
to generate WiX textBox element on the base of this instance properties.
</para>
</summary>
</member>
<member name="P:WixSharp.Controls.WixTextBox.Conditions">
<summary>
Gets or sets the control conditions.
</summary>
<value>
The control conditions.
</value>
</member>
<member name="M:WixSharp.Controls.WixTextBox.#ctor">
<summary>
Initializes a new instance of the <see cref="T:WixSharp.Controls.WixTextBox"/> class.
</summary>
</member>
<member name="P:WixSharp.Controls.WixTextBox.WixSize">
<summary>
Gets the size of the <c>Control</c>.
</summary>
<value>
The size of the <c>Control</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.WixLocation">
<summary>
Gets the <c>Control</c> location.
</summary>
<value>
The <c>Control</c> location.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.Id">
<summary>
Gets or sets the Id.
</summary>
<value>
The Id.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.Tooltip">
<summary>
Gets or sets the tooltip.
</summary>
<value>
The tooltip.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.BoundProperty">
<summary>
Gets or sets the bound property name.
</summary>
<value>
The bound property name.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.Hidden">
<summary>
Gets or sets a value indicating whether this <see cref="T:WixSharp.Controls.IWixControl" /> is hidden.
</summary>
<value>
<c>true</c> if hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:WixSharp.Controls.WixTextBox.WixAttributes">
<summary>
Gets or sets the WiX element attributes.
</summary>
<value>
The WiX element attributes.
</value>
</member>
<member name="M:WixSharp.Controls.WixTextBox.ToWControl">
<summary>
Converts the WinForm control into WiX custom UI control <see cref="T:WixSharp.Control" />.
</summary>
<returns>
Instance of the WixSharp.Control.
</returns>
<exception cref="T:System.ApplicationException">WixTextBox (' + control.Id + ') must have BoundProperty set to non-empty value.</exception>
</member>
</members>
</doc>