[mapguide-commits] r5341 - in sandbox/maestro-3.0: Maestro.Editors
Maestro.Editors/Common Maestro.Editors/Diagnostics
Maestro.Editors/DrawingSource Maestro.Editors/FeatureSource
Maestro.Editors/FeatureSource/CoordSys
Maestro.Editors/FeatureSource/Extensions
Maestro.Editors/FeatureSource/Preview
Maestro.Editors/FeatureSource/Providers
Maestro.Editors/FeatureSource/Providers/Rdbms
Maestro.Editors/FeatureSource/Providers/Sdf
Maestro.Editors/FeatureSource/Providers/Shp
Maestro.Editors/Generic Maestro.Editors/LayerDefinition
Maestro.Editors/LayerDefinition/Drawing
Maestro.Editors/LayerDefinition/Vector
Maestro.Editors/LayerDefinition/Vector/Scales
Maestro.Editors/LayerDefinition/Vector/StyleEditors
Maestro.Editors/LayerDefinition/Vector/Thematics
Maestro.Editors/LoadProcedure Maestro.Editors/MapDefinition
Maestro.Editors/Migration Maestro.Editors/PrintLayout
Maestro.Editors/WebLayout Maestro.Editors/WebLayout/Commands
Maestro.Login Maestro.Packaging Maestro.Shared.UI
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Oct 27 05:53:07 EDT 2010
Author: jng
Date: 2010-10-27 02:53:07 -0700 (Wed, 27 Oct 2010)
New Revision: 5341
Modified:
sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboBox.cs
sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboWithTransparency.cs
sandbox/maestro-3.0/Maestro.Editors/Common/CoordinateSystemPicker.cs
sandbox/maestro-3.0/Maestro.Editors/Common/CustomCombo.cs
sandbox/maestro-3.0/Maestro.Editors/Common/EditorBindableCollapsiblePanel.cs
sandbox/maestro-3.0/Maestro.Editors/Common/ExpressionEditor.cs
sandbox/maestro-3.0/Maestro.Editors/Common/ImageStylePicker.cs
sandbox/maestro-3.0/Maestro.Editors/Common/ResourceDataCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/Common/ResourcePicker.cs
sandbox/maestro-3.0/Maestro.Editors/Common/SymbolPicker.cs
sandbox/maestro-3.0/Maestro.Editors/Common/UnmanagedFileBrowser.cs
sandbox/maestro-3.0/Maestro.Editors/Diagnostics/ServerStatusMonitor.cs
sandbox/maestro-3.0/Maestro.Editors/DrawingSource/DrawingSourceEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/EditorBase.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSys/CoordSysOverrideDialog.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSysOverrideCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/CalculationSettings.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/ExtendedClassSettings.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/SelectJoinKeyDialog.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/ExtensionsCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FeatureSourceEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FsEditorMap.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/IQueryControl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/LocalFeatureSourcePreviewCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/SqlQueryCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/StandardQueryCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/FileBasedCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/GenericCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/MySqlCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/PostgreSqlCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/RdbmsBaseCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/SqlServerSpatialCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Sdf/SdfFileCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Shp/ShpFileCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/Generic/ResourceDataPanel.cs
sandbox/maestro-3.0/Maestro.Editors/Generic/XmlEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/Generic/XmlValidationResult.cs
sandbox/maestro-3.0/Maestro.Editors/IEditorBindable.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Drawing/DrawingLayerSettingsCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/DrawingLayerEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/FeaturePreviewRender.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/Condition.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionList.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionListButtons.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/EditorTemplateForm.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ItemStyle.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRange.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeConditions.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeList.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/AreaFeatureStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FillStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FontStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineFeatureStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/PointFeatureStyleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ScaleRangeEditor.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ColorBrewer.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ThemeCreator.cs
sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/VectorLayerEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/DwfTransformationCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ExecuteCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/InputFilesCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadProcedureEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadTargetCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SdfTransformationCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ShpTransformationCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SqliteTransformationCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/FiniteScaleListCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/GroupPropertiesCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/LayerPropertiesCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/ManualScaleEditor.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapDefinitionEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapLayersSectionCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/Migration/CopyMoveToServerDialog.cs
sandbox/maestro-3.0/Maestro.Editors/Migration/MigrateDialog.cs
sandbox/maestro-3.0/Maestro.Editors/PrintLayout/LogoDialog.cs
sandbox/maestro-3.0/Maestro.Editors/PrintLayout/PrintLayoutEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/PrintLayout/TextDialog.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/CommandIconCache.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeScriptCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeURLCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/SearchCmdCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/CustomCommandPropertyCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/MenuEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutCommandsCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutEditorCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutMenusCtrl.cs
sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutSettingsCtrl.cs
sandbox/maestro-3.0/Maestro.Login/HttpLoginCtrl.cs
sandbox/maestro-3.0/Maestro.Login/ILoginCtrl.cs
sandbox/maestro-3.0/Maestro.Login/LocalNativeLoginCtrl.cs
sandbox/maestro-3.0/Maestro.Login/LoginDialog.cs
sandbox/maestro-3.0/Maestro.Login/PreferedSite.cs
sandbox/maestro-3.0/Maestro.Login/WaitCursor.cs
sandbox/maestro-3.0/Maestro.Packaging/PackageBuilder.cs
sandbox/maestro-3.0/Maestro.Packaging/PackageProgress.cs
sandbox/maestro-3.0/Maestro.Packaging/ResourceDataItem.cs
sandbox/maestro-3.0/Maestro.Packaging/ResourceItem.cs
sandbox/maestro-3.0/Maestro.Shared.UI/CancelException.cs
sandbox/maestro-3.0/Maestro.Shared.UI/CheckBoxBinder.cs
sandbox/maestro-3.0/Maestro.Shared.UI/CollapsiblePanel.cs
sandbox/maestro-3.0/Maestro.Shared.UI/ComboBoxBinder.cs
sandbox/maestro-3.0/Maestro.Shared.UI/Maestro.Shared.UI.csproj
sandbox/maestro-3.0/Maestro.Shared.UI/NumericBinder.cs
sandbox/maestro-3.0/Maestro.Shared.UI/ProgressDialog.cs
sandbox/maestro-3.0/Maestro.Shared.UI/TextBoxBinder.cs
sandbox/maestro-3.0/Maestro.Shared.UI/WaitCursor.cs
Log:
3.0 sandbox changes:
- Add API documentation for:
- Maestro.Editors
- Maestro.Shared.UI
- Maestro.Packaging
- Maestro.Login
- Internalize a whole bunch of classes in Maestro.Editors as they have no business being public (and saved a lot of unnecessary documentation effort)
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboBox.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboBox.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboBox.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -24,6 +24,9 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A combo box customised for selection of colors
+ /// </summary>
[Serializable]
public class ColorComboBox
: CustomCombo
@@ -33,6 +36,9 @@
private ColorDialog m_colorPicker;
private static ColorDialog m_sharedColorPicker;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ColorComboBox"/> class.
+ /// </summary>
public ColorComboBox()
: base()
{
@@ -45,6 +51,9 @@
}
}
+ /// <summary>
+ /// Resets the colors.
+ /// </summary>
public void ResetColors()
{
base.Items.Clear();
@@ -58,6 +67,10 @@
base.Items.Add(SpecialCell.MoreColors);
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [allow transparent].
+ /// </summary>
+ /// <value><c>true</c> if [allow transparent]; otherwise, <c>false</c>.</value>
[ System.ComponentModel.Browsable(false), System.ComponentModel.ReadOnly(true) ]
public bool AllowTransparent
{
@@ -65,6 +78,10 @@
set { m_allowTransparent = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [transparent selected].
+ /// </summary>
+ /// <value><c>true</c> if [transparent selected]; otherwise, <c>false</c>.</value>
[ System.ComponentModel.Browsable(false), System.ComponentModel.ReadOnly(true) ]
public bool TransparentSelected
{
@@ -78,6 +95,10 @@
}
}
+ /// <summary>
+ /// Gets or sets the color of the current.
+ /// </summary>
+ /// <value>The color of the current.</value>
[ System.ComponentModel.Browsable(false), System.ComponentModel.ReadOnly(true) ]
public Color CurrentColor
{
@@ -105,6 +126,10 @@
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.ComboBox.MeasureItem"/> event.
+ /// </summary>
+ /// <param name="e">The <see cref="T:System.Windows.Forms.MeasureItemEventArgs"/> that was raised.</param>
protected override void OnMeasureItem(MeasureItemEventArgs e)
{
if (e.Index < 0)
@@ -126,6 +151,10 @@
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.ComboBox.SelectedIndexChanged"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnSelectedIndexChanged(EventArgs e)
{
if (this.SelectedItem != null && this.SelectedItem.ToString() == Properties.Resources.MoreColorsName)
@@ -174,6 +203,13 @@
Color.Cyan
};
+ /// <summary>
+ /// Gets an object representing the collection of the items contained in this <see cref="T:System.Windows.Forms.ComboBox"/>.
+ /// </summary>
+ /// <value></value>
+ /// <returns>
+ /// A <see cref="T:System.Windows.Forms.ComboBox.ObjectCollection"/> representing the items in the <see cref="T:System.Windows.Forms.ComboBox"/>.
+ /// </returns>
[ System.ComponentModel.Browsable(false), System.ComponentModel.ReadOnly(true) ]
public new ComboBox.ObjectCollection Items
{
@@ -266,6 +302,10 @@
return true;
}
+ /// <summary>
+ /// Gets or sets the color picker.
+ /// </summary>
+ /// <value>The color picker.</value>
public ColorDialog ColorPicker
{
get
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboWithTransparency.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboWithTransparency.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ColorComboWithTransparency.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,10 +27,16 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A color combo box with transparency support
+ /// </summary>
public partial class ColorComboWithTransparency : UserControl
{
private bool m_isUpdating = false;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ColorComboWithTransparency"/> class.
+ /// </summary>
public ColorComboWithTransparency()
{
InitializeComponent();
@@ -38,8 +44,15 @@
colorCombo.ResetColors();
}
+ /// <summary>
+ /// Occurs when [current color changed].
+ /// </summary>
public event EventHandler CurrentColorChanged;
+ /// <summary>
+ /// Gets or sets the color of the current.
+ /// </summary>
+ /// <value>The color of the current.</value>
public Color CurrentColor
{
get { return Color.FromArgb((byte.MaxValue - transparencySlider.Value), colorCombo.CurrentColor); }
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/CoordinateSystemPicker.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/CoordinateSystemPicker.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/CoordinateSystemPicker.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,6 +28,9 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A coordinate system picker dialog
+ /// </summary>
public partial class CoordinateSystemPicker : Form
{
private CoordinateSystemPicker()
@@ -44,6 +47,10 @@
private ICoordinateSystemCatalog _cat;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CoordinateSystemPicker"/> class.
+ /// </summary>
+ /// <param name="cat">The cat.</param>
public CoordinateSystemPicker(ICoordinateSystemCatalog cat) : this()
{
if (cat == null)
@@ -61,6 +68,10 @@
_cat = cat;
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
this.Visible = true;
@@ -222,6 +233,10 @@
m_selectedCoordsys = null;
}
+ /// <summary>
+ /// Gets the selected coord sys.
+ /// </summary>
+ /// <value>The selected coord sys.</value>
public CoordinateSystemBase SelectedCoordSys
{
get { return m_selectedCoordsys; }
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/CustomCombo.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/CustomCombo.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/CustomCombo.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,6 +33,9 @@
public class CustomCombo : System.Windows.Forms.ComboBox
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CustomCombo"/> class.
+ /// </summary>
public CustomCombo()
: base()
{
@@ -43,6 +46,10 @@
}
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.ComboBox.DrawItem"/> event.
+ /// </summary>
+ /// <param name="e">A <see cref="T:System.Windows.Forms.DrawItemEventArgs"/> that contains the event data.</param>
protected override void OnDrawItem(DrawItemEventArgs e)
{
bool handled = false;
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/EditorBindableCollapsiblePanel.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/EditorBindableCollapsiblePanel.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/EditorBindableCollapsiblePanel.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,11 +30,21 @@
/// </summary>
public class EditorBindableCollapsiblePanel : CollapsiblePanel, IEditorBindable
{
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public virtual void Bind(IEditorService service)
{
throw new NotImplementedException();
}
+ /// <summary>
+ /// Clean up any resources being used.
+ /// </summary>
+ /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
protected override void Dispose(bool disposing)
{
if (disposing)
@@ -73,6 +83,9 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Occurs when [resource changed].
+ /// </summary>
public event EventHandler ResourceChanged;
}
}
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ExpressionEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ExpressionEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ExpressionEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -70,36 +70,53 @@
* 6 - Show the auto-complete box
*/
+ /// <summary>
+ /// An expression editor dialog
+ /// </summary>
public partial class ExpressionEditor : Form
{
- private ClassDefinition m_schema;
+ private ClassDefinition _cls;
private IFeatureService _featSvc;
private string m_featureSource = null;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ExpressionEditor"/> class.
+ /// </summary>
public ExpressionEditor()
{
InitializeComponent();
InitAutoComplete();
}
+ /// <summary>
+ /// Gets or sets the expression.
+ /// </summary>
+ /// <value>The expression.</value>
public string Expression
{
get { return ExpressionText.Text; }
set { ExpressionText.Text = value; }
}
- public void Initialize(IFeatureService featSvc, FdoProviderCapabilities caps, ClassDefinition schema, string featuresSourceId)
+ /// <summary>
+ /// Initializes the dialog.
+ /// </summary>
+ /// <param name="featSvc">The feature service.</param>
+ /// <param name="caps">The provider capabilities.</param>
+ /// <param name="cls">The class definition.</param>
+ /// <param name="featuresSourceId">The features source id.</param>
+ public void Initialize(IFeatureService featSvc, FdoProviderCapabilities caps, ClassDefinition cls, string featuresSourceId)
{
try
{
- m_schema = schema;
+ _cls = cls;
_featSvc = featSvc;
m_featureSource = featuresSourceId;
//TODO: Perhaps add column type and indication of primary key
SortedList<string, FeatureSetColumn> sortedCols = new SortedList<string, FeatureSetColumn>();
- foreach (FeatureSetColumn col in m_schema.Columns)
+ foreach (FeatureSetColumn col in _cls.Columns)
{
sortedCols.Add(col.Name, col);
}
@@ -125,7 +142,7 @@
if (ColumnName.Items.Count > 0)
ColumnName.SelectedIndex = 0;
- LoadCompletableProperties(m_schema.Columns);
+ LoadCompletableProperties(_cls.Columns);
//TODO: Figure out how to translate the enums into something usefull
@@ -751,7 +768,7 @@
try
{
retry = false;
- using (FeatureSetReader rd = _featSvc.QueryFeatureSource(m_featureSource, m_schema.QualifiedNameDecoded, filter, new string[] { ColumnName.Text }))
+ using (FeatureSetReader rd = _featSvc.QueryFeatureSource(m_featureSource, _cls.QualifiedNameDecoded, filter, new string[] { ColumnName.Text }))
{
while (rd.Read())
{
@@ -817,7 +834,7 @@
}
// ImageListBoxItem class
- public class ImageListBoxItem
+ internal class ImageListBoxItem
{
private string _myText;
private int _myImageIndex;
@@ -860,7 +877,8 @@
// Based on GListBox
//
// http://www.codeproject.com/KB/combobox/glistbox.aspx
- public class ImageListBox : ListBox
+
+ internal class ImageListBox : ListBox
{
private ImageList _myImageList;
public ImageList ImageList
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ImageStylePicker.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ImageStylePicker.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ImageStylePicker.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -23,12 +23,18 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A custom combobox to choose image styles
+ /// </summary>
public class ImageStylePicker
: CustomCombo
{
private int m_itemHeight = 20;
private int m_textWidth = 40;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ImageStylePicker"/> class.
+ /// </summary>
public ImageStylePicker()
: base()
{
@@ -40,12 +46,20 @@
}
}
+ /// <summary>
+ /// Gets or sets the width of the text.
+ /// </summary>
+ /// <value>The width of the text.</value>
public int TextWidth
{
get { return m_textWidth; }
set { m_textWidth = value; }
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.ComboBox.MeasureItem"/> event.
+ /// </summary>
+ /// <param name="e">The <see cref="T:System.Windows.Forms.MeasureItemEventArgs"/> that was raised.</param>
protected override void OnMeasureItem(MeasureItemEventArgs e)
{
if (e.Index < 0)
@@ -114,8 +128,16 @@
return true;
}
+ /// <summary>
+ /// A named image instance
+ /// </summary>
public class NamedImage
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="NamedImage"/> class.
+ /// </summary>
+ /// <param name="name">The name.</param>
+ /// <param name="image">The image.</param>
public NamedImage(string name, Image image)
{
m_name = name;
@@ -125,12 +147,20 @@
private Image m_image;
private string m_name;
+ /// <summary>
+ /// Gets or sets the image.
+ /// </summary>
+ /// <value>The image.</value>
public Image Image
{
get { return m_image; }
set { m_image = value; }
}
+ /// <summary>
+ /// Gets or sets the name.
+ /// </summary>
+ /// <value>The name.</value>
public string Name
{
get { return m_name; }
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ResourceDataCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ResourceDataCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ResourceDataCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,14 +33,23 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A control that manages attached resource data for a resource
+ /// </summary>
public partial class ResourceDataCtrl : UserControl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceDataCtrl"/> class.
+ /// </summary>
public ResourceDataCtrl()
{
InitializeComponent();
this.MarkEnabled = false;
}
+ /// <summary>
+ /// Occurs when [data list changed].
+ /// </summary>
public event EventHandler DataListChanged;
private void EvaluateCommands()
@@ -67,6 +76,10 @@
}
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.UserControl.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
EvaluateCommands();
@@ -74,6 +87,10 @@
private string _resourceID;
+ /// <summary>
+ /// Inits the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public void Init(IEditorService service)
{
_edSvc = service;
@@ -84,12 +101,20 @@
EvaluateCommands();
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [mark enabled].
+ /// </summary>
+ /// <value><c>true</c> if [mark enabled]; otherwise, <c>false</c>.</value>
public bool MarkEnabled
{
get { return btnMark.Visible; }
set { btnMark.Visible = value; }
}
+ /// <summary>
+ /// Gets or sets the marked file.
+ /// </summary>
+ /// <value>The marked file.</value>
public string MarkedFile
{
get
@@ -267,6 +292,9 @@
EvaluateCommands();
}
+ /// <summary>
+ /// Occurs when [resource data marked].
+ /// </summary>
public event ResourceDataSelectionEventHandler ResourceDataMarked;
private void OnResourceDataMarked(string name)
@@ -321,5 +349,8 @@
}
}
+ /// <summary>
+ ///
+ /// </summary>
public delegate void ResourceDataSelectionEventHandler(object sender, string dataName);
}
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/ResourcePicker.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/ResourcePicker.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/ResourcePicker.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -81,7 +81,8 @@
/// folder selection is desired, set <see cref="SelectFoldersOnly"/> to true before
/// showing the dialog
/// </summary>
- /// <param name="resSvc"></param>
+ /// <param name="resSvc">The res SVC.</param>
+ /// <param name="mode">The mode.</param>
public ResourcePicker(IResourceService resSvc, ResourcePickerMode mode)
: this()
{
@@ -97,6 +98,10 @@
UpdateDocumentList();
}
+ /// <summary>
+ /// Sets the starting point.
+ /// </summary>
+ /// <param name="folderId">The folder id.</param>
public void SetStartingPoint(string folderId)
{
if (!ResourceIdentifier.IsFolderResource(folderId))
@@ -106,6 +111,10 @@
private ResourcePickerMode _mode = ResourcePickerMode.OpenResource;
+ /// <summary>
+ /// Gets or sets the mode.
+ /// </summary>
+ /// <value>The mode.</value>
public ResourcePickerMode Mode
{
get { return _mode; }
@@ -134,8 +143,9 @@
/// You cannot select folders in this mode. Attempting to set <see cref="SelectFoldersOnly"/> to
/// true will throw an <see cref="InvalidOperationException"/>
/// </summary>
- /// <param name="resSvc"></param>
- /// <param name="resFilter"></param>
+ /// <param name="resSvc">The res SVC.</param>
+ /// <param name="resFilter">The res filter.</param>
+ /// <param name="mode">The mode.</param>
public ResourcePicker(IResourceService resSvc, ResourceTypes resFilter, ResourcePickerMode mode)
: this(resSvc, mode)
{
@@ -391,10 +401,22 @@
}
}
+ /// <summary>
+ /// Defines the various modes this resource picker can be in
+ /// </summary>
public enum ResourcePickerMode
{
+ /// <summary>
+ ///
+ /// </summary>
OpenResource,
+ /// <summary>
+ ///
+ /// </summary>
SaveResource,
+ /// <summary>
+ ///
+ /// </summary>
OpenFolder
}
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/SymbolPicker.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/SymbolPicker.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/SymbolPicker.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,6 +31,9 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A dialog to pick symbols from a DWF symbol library
+ /// </summary>
public partial class SymbolPicker : Form
{
private SymbolPicker()
@@ -40,6 +43,11 @@
private IServerConnection _conn;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="SymbolPicker"/> class.
+ /// </summary>
+ /// <param name="symbolLibrary">The symbol library.</param>
+ /// <param name="conn">The conn.</param>
public SymbolPicker(string symbolLibrary, IServerConnection conn)
: this()
{
@@ -50,6 +58,10 @@
txtSymbolLibrary.Text = symbolLibrary;
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
//Extract the symbols.dwf resource data and copy to a session based drawing source
@@ -117,6 +129,10 @@
btnOK.Enabled = (lstSymbols.SelectedItems.Count == 1);
}
+ /// <summary>
+ /// Gets the name of the symbol.
+ /// </summary>
+ /// <value>The name of the symbol.</value>
public string SymbolName
{
get
Modified: sandbox/maestro-3.0/Maestro.Editors/Common/UnmanagedFileBrowser.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Common/UnmanagedFileBrowser.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Common/UnmanagedFileBrowser.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,6 +30,9 @@
namespace Maestro.Editors.Common
{
+ /// <summary>
+ /// A dialog to browse and select unmanaged resources
+ /// </summary>
public partial class UnmanagedFileBrowser : Form
{
abstract class ModelBase<T>
@@ -122,6 +125,10 @@
private bool _selectFoldersOnly;
+ /// <summary>
+ /// Gets or sets a value indicating whether [select folders only].
+ /// </summary>
+ /// <value><c>true</c> if [select folders only]; otherwise, <c>false</c>.</value>
public bool SelectFoldersOnly
{
get { return _selectFoldersOnly; }
@@ -139,6 +146,10 @@
private IResourceService _resSvc;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="UnmanagedFileBrowser"/> class.
+ /// </summary>
+ /// <param name="resSvc">The res SVC.</param>
public UnmanagedFileBrowser(IResourceService resSvc)
: this()
{
@@ -146,6 +157,10 @@
trvFolders.Model = new FolderTreeModel(_resSvc);
}
+ /// <summary>
+ /// Gets the selected item.
+ /// </summary>
+ /// <value>The selected item.</value>
public string SelectedItem
{
get
Modified: sandbox/maestro-3.0/Maestro.Editors/Diagnostics/ServerStatusMonitor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Diagnostics/ServerStatusMonitor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Diagnostics/ServerStatusMonitor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,6 +30,9 @@
namespace Maestro.Editors.Diagnostics
{
+ /// <summary>
+ /// A window that display the SiteInformation responses from a MapGuide Server
+ /// </summary>
public partial class ServerStatusMonitor : Form
{
private ServerStatusMonitor()
@@ -47,6 +50,10 @@
private void StopTimer() { pollTimer.Stop(); }
+ /// <summary>
+ /// Initializes with the specified site service
+ /// </summary>
+ /// <param name="conn">The site service.</param>
public static void Init(ISiteService conn)
{
_smConn = conn;
@@ -62,6 +69,9 @@
private static ServerStatusMonitor _smMonitor;
+ /// <summary>
+ /// Shows the window.
+ /// </summary>
public static void ShowWindow()
{
if (_smConn != null)
@@ -76,6 +86,9 @@
}
}
+ /// <summary>
+ /// Hides the window.
+ /// </summary>
public static void HideWindow()
{
_smMonitor.StopTimer();
Modified: sandbox/maestro-3.0/Maestro.Editors/DrawingSource/DrawingSourceEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/DrawingSource/DrawingSourceEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/DrawingSource/DrawingSourceEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,13 +27,23 @@
namespace Maestro.Editors.DrawingSource
{
+ /// <summary>
+ /// Editor control for Drawing Sources
+ /// </summary>
public partial class DrawingSourceEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="DrawingSourceEditorCtrl"/> class.
+ /// </summary>
public DrawingSourceEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Binds the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public override void Bind(IEditorService service)
{
service.RegisterCustomNotifier(this);
Modified: sandbox/maestro-3.0/Maestro.Editors/EditorBase.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/EditorBase.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/EditorBase.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -25,13 +25,25 @@
namespace Maestro.Editors
{
+ /// <summary>
+ /// Base class of all resource editors
+ /// </summary>
public class EditorBase : UserControl, IEditorBindable
{
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public virtual void Bind(IEditorService service)
{
throw new NotImplementedException();
}
+ /// <summary>
+ /// </summary>
+ /// <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
protected override void Dispose(bool disposing)
{
if (disposing)
@@ -41,6 +53,9 @@
base.Dispose(disposing);
}
+ /// <summary>
+ /// Unsubscribes the event handlers.
+ /// </summary>
protected virtual void UnsubscribeEventHandlers()
{
var handler = this.ResourceChanged;
@@ -54,6 +69,9 @@
}
}
+ /// <summary>
+ /// Called when [resource changed].
+ /// </summary>
protected virtual void OnResourceChanged()
{
var handler = this.ResourceChanged;
@@ -61,11 +79,20 @@
handler(this, EventArgs.Empty);
}
+ /// <summary>
+ /// Occurs when [resource changed].
+ /// </summary>
public event EventHandler ResourceChanged;
}
+ /// <summary>
+ /// An interface for flagging dirty state
+ /// </summary>
public interface INotifyResourceChanged
{
+ /// <summary>
+ /// Occurs when [resource changed].
+ /// </summary>
event EventHandler ResourceChanged;
}
}
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSys/CoordSysOverrideDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSys/CoordSysOverrideDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSys/CoordSysOverrideDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.FeatureSource.CoordSys
{
- public partial class CoordSysOverrideDialog : Form
+ internal partial class CoordSysOverrideDialog : Form
{
private CoordSysOverrideDialog()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSysOverrideCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSysOverrideCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/CoordSysOverrideCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,7 +33,7 @@
namespace Maestro.Editors.FeatureSource
{
- public partial class CoordSysOverrideCtrl : EditorBindableCollapsiblePanel
+ internal partial class CoordSysOverrideCtrl : EditorBindableCollapsiblePanel
{
public CoordSysOverrideCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/CalculationSettings.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/CalculationSettings.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/CalculationSettings.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.FeatureSource.Extensions
{
- public partial class CalculationSettings : UserControl
+ internal partial class CalculationSettings : UserControl
{
private CalculationSettings()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/ExtendedClassSettings.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/ExtendedClassSettings.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/ExtendedClassSettings.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.FeatureSource.Extensions
{
- public partial class ExtendedClassSettings : UserControl, IEditorBindable
+ internal partial class ExtendedClassSettings : UserControl, IEditorBindable
{
private ExtendedClassSettings()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/JoinSettings.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.FeatureSource.Extensions
{
- public partial class JoinSettings : UserControl, IEditorBindable
+ internal partial class JoinSettings : UserControl, IEditorBindable
{
private JoinSettings()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/SelectJoinKeyDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/SelectJoinKeyDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Extensions/SelectJoinKeyDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,7 +28,7 @@
namespace Maestro.Editors.FeatureSource.Extensions
{
- public partial class SelectJoinKeyDialog : Form
+ internal partial class SelectJoinKeyDialog : Form
{
internal SelectJoinKeyDialog()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/ExtensionsCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/ExtensionsCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/ExtensionsCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -35,7 +35,7 @@
namespace Maestro.Editors.FeatureSource
{
- public partial class ExtensionsCtrl : EditorBindableCollapsiblePanel
+ internal partial class ExtensionsCtrl : EditorBindableCollapsiblePanel
{
public ExtensionsCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FeatureSourceEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FeatureSourceEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FeatureSourceEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,8 +33,14 @@
namespace Maestro.Editors.FeatureSource
{
+ /// <summary>
+ /// Editor control for Feature Sources
+ /// </summary>
public partial class FeatureSourceEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="FeatureSourceEditorCtrl"/> class.
+ /// </summary>
public FeatureSourceEditorCtrl()
{
InitializeComponent();
@@ -42,6 +48,10 @@
private IFeatureSource _fs;
+ /// <summary>
+ /// Binds the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public override void Bind(IEditorService service)
{
_fs = service.GetEditedResource() as IFeatureSource;
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FsEditorMap.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FsEditorMap.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/FsEditorMap.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -7,7 +7,7 @@
namespace Maestro.Editors.FeatureSource
{
- public static class FsEditorMap
+ internal static class FsEditorMap
{
static Dictionary<string, Type> _editors;
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/IQueryControl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/IQueryControl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/IQueryControl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -25,7 +25,7 @@
namespace Maestro.Editors.FeatureSource.Preview
{
- public interface IQueryControl
+ internal interface IQueryControl
{
FeatureSetReader ExecuteQuery();
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/LocalFeatureSourcePreviewCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/LocalFeatureSourcePreviewCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/LocalFeatureSourcePreviewCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,8 +31,14 @@
namespace Maestro.Editors.FeatureSource.Preview
{
+ /// <summary>
+ /// A control that allows local previewing of a feature source
+ /// </summary>
public partial class LocalFeatureSourcePreviewCtrl : UserControl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LocalFeatureSourcePreviewCtrl"/> class.
+ /// </summary>
public LocalFeatureSourcePreviewCtrl()
{
InitializeComponent();
@@ -40,6 +46,10 @@
private IFeatureService _fsvc;
+ /// <summary>
+ /// Initializes this instance
+ /// </summary>
+ /// <param name="featureService">The feature service.</param>
public void Init(IFeatureService featureService)
{
_fsvc = featureService;
@@ -54,6 +64,10 @@
private string currentFsId;
+ /// <summary>
+ /// Gets or sets a value indicating whether [supports SQL].
+ /// </summary>
+ /// <value><c>true</c> if [supports SQL]; otherwise, <c>false</c>.</value>
public bool SupportsSQL
{
get;
@@ -62,6 +76,11 @@
private FdoProviderCapabilities _caps;
+ /// <summary>
+ /// Reloads the tree.
+ /// </summary>
+ /// <param name="fsId">The fs id.</param>
+ /// <param name="caps">The caps.</param>
public void ReloadTree(string fsId, FdoProviderCapabilities caps)
{
currentFsId = fsId;
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/SqlQueryCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/SqlQueryCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/SqlQueryCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,7 +28,7 @@
namespace Maestro.Editors.FeatureSource.Preview
{
- public partial class SqlQueryCtrl : UserControl, IQueryControl
+ internal partial class SqlQueryCtrl : UserControl, IQueryControl
{
private SqlQueryCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/StandardQueryCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/StandardQueryCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Preview/StandardQueryCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.FeatureSource.Preview
{
- public partial class StandardQueryCtrl : UserControl, IQueryControl
+ internal partial class StandardQueryCtrl : UserControl, IQueryControl
{
private StandardQueryCtrl()
{
@@ -44,6 +44,13 @@
private ClassDefinition _cls;
private FdoProviderCapabilities _caps;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="StandardQueryCtrl"/> class.
+ /// </summary>
+ /// <param name="fsId">The fs id.</param>
+ /// <param name="featSvc">The feat SVC.</param>
+ /// <param name="cls">The CLS.</param>
+ /// <param name="caps">The caps.</param>
public StandardQueryCtrl(string fsId, IFeatureService featSvc, ClassDefinition cls, FdoProviderCapabilities caps)
: this()
{
@@ -57,6 +64,10 @@
}
}
+ /// <summary>
+ /// Executes the query.
+ /// </summary>
+ /// <returns></returns>
public FeatureSetReader ExecuteQuery()
{
return _featSvc.QueryFeatureSource(_fsId, _cls.QualifiedNameDecoded, txtFilter.Text, GetProperties(), GetComputedColumns());
@@ -83,6 +94,10 @@
return names.ToArray();
}
+ /// <summary>
+ /// Gets the content.
+ /// </summary>
+ /// <value>The content.</value>
public Control Content
{
get { return this; }
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/FileBasedCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/FileBasedCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/FileBasedCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.FeatureSource.Providers
{
- public partial class FileBasedCtrl : EditorBindableCollapsiblePanel
+ internal partial class FileBasedCtrl : EditorBindableCollapsiblePanel
{
public FileBasedCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/GenericCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/GenericCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/GenericCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,7 +33,7 @@
namespace Maestro.Editors.FeatureSource.Providers
{
- public partial class GenericCtrl : EditorBindableCollapsiblePanel
+ internal partial class GenericCtrl : EditorBindableCollapsiblePanel
{
internal GenericCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/MySqlCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/MySqlCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/MySqlCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Rdbms
{
- public partial class MySqlCtrl : RdbmsBaseCtrl
+ internal partial class MySqlCtrl : RdbmsBaseCtrl
{
public MySqlCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/PostgreSqlCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/PostgreSqlCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/PostgreSqlCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Rdbms
{
- public partial class PostgreSqlCtrl : RdbmsBaseCtrl
+ internal partial class PostgreSqlCtrl : RdbmsBaseCtrl
{
public PostgreSqlCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/RdbmsBaseCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/RdbmsBaseCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/RdbmsBaseCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Rdbms
{
- public partial class RdbmsBaseCtrl : EditorBindableCollapsiblePanel
+ internal partial class RdbmsBaseCtrl : EditorBindableCollapsiblePanel
{
public RdbmsBaseCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/SqlServerSpatialCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/SqlServerSpatialCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Rdbms/SqlServerSpatialCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Rdbms
{
- public partial class SqlServerSpatialCtrl : RdbmsBaseCtrl
+ internal partial class SqlServerSpatialCtrl : RdbmsBaseCtrl
{
public SqlServerSpatialCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Sdf/SdfFileCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Sdf/SdfFileCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Sdf/SdfFileCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Sdf
{
- public partial class SdfFileCtrl : FileBasedCtrl
+ internal partial class SdfFileCtrl : FileBasedCtrl
{
public SdfFileCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Shp/ShpFileCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Shp/ShpFileCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/FeatureSource/Providers/Shp/ShpFileCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.FeatureSource.Providers.Shp
{
- public partial class ShpFileCtrl : FileBasedCtrl
+ internal partial class ShpFileCtrl : FileBasedCtrl
{
public ShpFileCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/Generic/ResourceDataPanel.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Generic/ResourceDataPanel.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Generic/ResourceDataPanel.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.Generic
{
[ToolboxItem(true)]
- public partial class ResourceDataPanel : CollapsiblePanel
+ internal partial class ResourceDataPanel : CollapsiblePanel
{
public ResourceDataPanel()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/Generic/XmlEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Generic/XmlEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Generic/XmlEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,42 +33,74 @@
namespace Maestro.Editors.Generic
{
+ /// <summary>
+ ///
+ /// </summary>
public delegate void XmlValidationCallback(out string[] errors, out string[] warnings);
+ /// <summary>
+ /// A generic XML content editor
+ /// </summary>
public partial class XmlEditorCtrl : EditorBase, INotifyResourceChanged
{
private bool _ready = false;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="XmlEditorCtrl"/> class.
+ /// </summary>
public XmlEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Gets or sets the validator.
+ /// </summary>
+ /// <value>The validator.</value>
public XmlValidationCallback Validator { get; set; }
+ /// <summary>
+ /// Gets or sets the color of the text.
+ /// </summary>
+ /// <value>The color of the text.</value>
public Color TextColor
{
get { return txtXmlContent.ForeColor; }
set { txtXmlContent.ForeColor = value; }
}
+ /// <summary>
+ /// Gets or sets the color of the background.
+ /// </summary>
+ /// <value>The color of the background.</value>
public Color BackgroundColor
{
get { return txtXmlContent.BackColor; }
set { txtXmlContent.BackColor = value; }
}
+ /// <summary>
+ /// Gets or sets the text font.
+ /// </summary>
+ /// <value>The text font.</value>
public Font TextFont
{
get { return txtXmlContent.Font; }
set { txtXmlContent.Font = value; }
}
+ /// <summary>
+ /// Readies for editing.
+ /// </summary>
public void ReadyForEditing()
{
_ready = true;
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.UserControl.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
EvaluateCommands();
@@ -83,6 +115,10 @@
btnValidate.Enabled = (this.Validator != null);
}
+ /// <summary>
+ /// Gets or sets the content of the XML.
+ /// </summary>
+ /// <value>The content of the XML.</value>
public string XmlContent
{
get { return txtXmlContent.Text; }
@@ -254,6 +290,10 @@
}
}
+ /// <summary>
+ /// Binds the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public override void Bind(IEditorService service)
{
var res = service.GetEditedResource();
@@ -261,6 +301,10 @@
InitResourceData(service);
}
+ /// <summary>
+ /// Inits the resource data.
+ /// </summary>
+ /// <param name="service">The service.</param>
public void InitResourceData(IEditorService service)
{
resDataCtrl.Init(service);
Modified: sandbox/maestro-3.0/Maestro.Editors/Generic/XmlValidationResult.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Generic/XmlValidationResult.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Generic/XmlValidationResult.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,10 @@
namespace Maestro.Editors.Generic
{
- public partial class XmlValidationResult : Form
+ /// <summary>
+ /// Dialog to show the results of a validation
+ /// </summary>
+ internal partial class XmlValidationResult : Form
{
class MessageItem
{
Modified: sandbox/maestro-3.0/Maestro.Editors/IEditorBindable.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/IEditorBindable.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/IEditorBindable.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -23,6 +23,9 @@
namespace Maestro.Editors
{
+ /// <summary>
+ /// Represents a editor that interacts with an editor service
+ /// </summary>
public interface IEditorBindable : INotifyResourceChanged
{
/// <summary>
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Drawing/DrawingLayerSettingsCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Drawing/DrawingLayerSettingsCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Drawing/DrawingLayerSettingsCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.LayerDefinition.Drawing
{
[ToolboxItem(true)]
- public partial class DrawingLayerSettingsCtrl : CollapsiblePanel,IEditorBindable
+ internal partial class DrawingLayerSettingsCtrl : CollapsiblePanel,IEditorBindable
{
public DrawingLayerSettingsCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/DrawingLayerEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/DrawingLayerEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/DrawingLayerEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,13 +27,25 @@
namespace Maestro.Editors.LayerDefinition
{
+ /// <summary>
+ /// Editor control for Drawing Layer Definitions
+ /// </summary>
public partial class DrawingLayerEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="DrawingLayerEditorCtrl"/> class.
+ /// </summary>
public DrawingLayerEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
drawingSettingsCtrl.Bind(service);
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/FeaturePreviewRender.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/FeaturePreviewRender.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/FeaturePreviewRender.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.LayerDefinition.Vector
{
- public class FeaturePreviewRender
+ internal class FeaturePreviewRender
{
private static ImageStylePicker.NamedImage[] m_fillImages = null;
private static ImageStylePicker.NamedImage[] m_lineStyles = null;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/Condition.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/Condition.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/Condition.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class Condition : UserControl
+ internal partial class Condition : UserControl
{
private IPointRule m_prt;
private ILineRule m_lrt;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionList.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionList.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionList.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class ConditionList : UserControl
+ internal partial class ConditionList : UserControl
{
private IPointVectorStyle m_point;
private ILineVectorStyle m_line;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionListButtons.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionListButtons.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ConditionListButtons.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class ConditionListButtons : UserControl
+ internal partial class ConditionListButtons : UserControl
{
private IPointVectorStyle m_point;
private ILineVectorStyle m_line;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/EditorTemplateForm.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/EditorTemplateForm.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/EditorTemplateForm.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class EditorTemplateForm : Form
+ internal partial class EditorTemplateForm : Form
{
public EditorTemplateForm()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ItemStyle.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ItemStyle.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ItemStyle.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class ItemStyle : UserControl
+ internal partial class ItemStyle : UserControl
{
private ITextSymbol m_label;
private IPointSymbolization2D m_point;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRange.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRange.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRange.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class ScaleRange : UserControl
+ internal partial class ScaleRange : UserControl
{
private IVectorScaleRange m_vsc;
private bool m_isUpdating = false;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeConditions.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeConditions.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeConditions.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Scales
{
- public partial class ScaleRangeConditions: UserControl
+ internal partial class ScaleRangeConditions: UserControl
{
public event EventHandler ItemChanged;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeList.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeList.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Scales/ScaleRangeList.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace OSGeo.MapGuide.Maestro.ResourceEditors.LayerEditorControls.ScaleControls
{
- public partial class ScaleRangeList : UserControl
+ internal partial class ScaleRangeList : UserControl
{
private IVectorLayerDefinition m_vldef;
public event EventHandler ItemChanged;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/AreaFeatureStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/AreaFeatureStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/AreaFeatureStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
/// <summary>
/// Summary description for AreaFeatureStyleEditor.
/// </summary>
- public class AreaFeatureStyleEditor : System.Windows.Forms.UserControl
+ internal class AreaFeatureStyleEditor : System.Windows.Forms.UserControl
{
private System.Windows.Forms.ComboBox sizeContextCombo;
private System.Windows.Forms.Label label4;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FillStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FillStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FillStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
/// <summary>
/// Summary description for FillStyleEditor.
/// </summary>
- public class FillStyleEditor : System.Windows.Forms.UserControl
+ internal class FillStyleEditor : System.Windows.Forms.UserControl
{
public ImageStylePicker fillCombo;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FontStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FontStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/FontStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,7 +33,7 @@
/// <summary>
/// Summary description for FontStyleEditor.
/// </summary>
- public class FontStyleEditor : System.Windows.Forms.UserControl
+ internal class FontStyleEditor : System.Windows.Forms.UserControl
{
private System.Windows.Forms.Label label1;
private System.Windows.Forms.Label label2;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineFeatureStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineFeatureStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineFeatureStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,7 +34,7 @@
/// <summary>
/// Summary description for LineFeatureStyleEditor.
/// </summary>
- public class LineFeatureStyleEditor : System.Windows.Forms.UserControl
+ internal class LineFeatureStyleEditor : System.Windows.Forms.UserControl
{
/// <summary>
/// Required designer variable.
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/LineStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
/// <summary>
/// Summary description for LineStyleEditor.
/// </summary>
- public class LineStyleEditor : System.Windows.Forms.UserControl
+ internal class LineStyleEditor : System.Windows.Forms.UserControl
{
public ImageStylePicker fillCombo;
public Label lblColor;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/PointFeatureStyleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/PointFeatureStyleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/PointFeatureStyleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -37,7 +37,7 @@
/// <summary>
/// Summary description for PointFeatureStyleEditor.
/// </summary>
- public class PointFeatureStyleEditor : System.Windows.Forms.UserControl
+ internal class PointFeatureStyleEditor : System.Windows.Forms.UserControl
{
private System.Windows.Forms.GroupBox groupBox1;
private System.Windows.Forms.Label label1;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ScaleRangeEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ScaleRangeEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/StyleEditors/ScaleRangeEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
/// <summary>
/// Summary description for ScaleRangeEditor.
/// </summary>
- public class ScaleRangeEditor : System.Windows.Forms.UserControl
+ internal class ScaleRangeEditor : System.Windows.Forms.UserControl
{
/// <summary>
/// Required designer variable.
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ColorBrewer.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ColorBrewer.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ColorBrewer.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -26,7 +26,7 @@
/// <summary>
/// Represents a ColorBrewer color set
/// </summary>
- public class ColorBrewer
+ internal class ColorBrewer
{
private string m_name;
private string m_type;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ThemeCreator.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ThemeCreator.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/Vector/Thematics/ThemeCreator.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -36,7 +36,7 @@
namespace Maestro.Editors.LayerDefinition.Vector.Thematics
{
- public partial class ThemeCreator : Form
+ internal partial class ThemeCreator : Form
{
private const int PREVIEW_ITEM_BOX_WIDTH = 20;
private const int PREVIEW_ITEM_BOX_SPACING = 10;
Modified: sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/VectorLayerEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/VectorLayerEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LayerDefinition/VectorLayerEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -11,8 +11,14 @@
namespace Maestro.Editors.LayerDefinition
{
+ /// <summary>
+ /// Editor control for Vector Layer Definitions
+ /// </summary>
public partial class VectorLayerEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="VectorLayerEditorCtrl"/> class.
+ /// </summary>
public VectorLayerEditorCtrl()
{
InitializeComponent();
@@ -27,6 +33,12 @@
private IEditorService _edsvc;
private IVectorLayerDefinition _vl;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
_edsvc = service;
@@ -39,6 +51,10 @@
layerStyles.Bind(service);
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.UserControl.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
//HACK: Maybe the controls were still in the process of databinding which
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/DwfTransformationCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/DwfTransformationCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/DwfTransformationCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class DwfTransformationCtrl : EditorBindableCollapsiblePanel
+ internal partial class DwfTransformationCtrl : EditorBindableCollapsiblePanel
{
public DwfTransformationCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ExecuteCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ExecuteCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ExecuteCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class ExecuteCtrl : UserControl
+ internal partial class ExecuteCtrl : UserControl
{
internal event EventHandler Execute;
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/InputFilesCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/InputFilesCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/InputFilesCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class InputFilesCtrl : EditorBindableCollapsiblePanel
+ internal partial class InputFilesCtrl : EditorBindableCollapsiblePanel
{
public InputFilesCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadProcedureEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadProcedureEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadProcedureEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,8 +30,14 @@
namespace Maestro.Editors.LoadProcedure
{
+ /// <summary>
+ /// Editor control for Load Procedures
+ /// </summary>
public partial class LoadProcedureEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LoadProcedureEditorCtrl"/> class.
+ /// </summary>
public LoadProcedureEditorCtrl()
{
InitializeComponent();
@@ -41,6 +47,10 @@
private IEditorService _ed;
+ /// <summary>
+ /// Binds the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public override void Bind(IEditorService service)
{
_ed = service;
@@ -132,6 +142,9 @@
return proc.CurrentConnection.ExecuteLoadProcedure(proc, cb, true);
}
+ /// <summary>
+ /// Occurs when [resource changed].
+ /// </summary>
public event EventHandler ResourceChanged;
}
}
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadTargetCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadTargetCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/LoadTargetCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class LoadTargetCtrl : EditorBindableCollapsiblePanel
+ internal partial class LoadTargetCtrl : EditorBindableCollapsiblePanel
{
public LoadTargetCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SdfTransformationCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SdfTransformationCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SdfTransformationCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class SdfTransformationCtrl : EditorBindableCollapsiblePanel
+ internal partial class SdfTransformationCtrl : EditorBindableCollapsiblePanel
{
public SdfTransformationCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ShpTransformationCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ShpTransformationCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/ShpTransformationCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class ShpTransformationCtrl : EditorBindableCollapsiblePanel
+ internal partial class ShpTransformationCtrl : EditorBindableCollapsiblePanel
{
public ShpTransformationCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SqliteTransformationCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SqliteTransformationCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/LoadProcedure/SqliteTransformationCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.LoadProcedure
{
- public partial class SqliteTransformationCtrl : EditorBindableCollapsiblePanel
+ internal partial class SqliteTransformationCtrl : EditorBindableCollapsiblePanel
{
public SqliteTransformationCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/FiniteScaleListCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/FiniteScaleListCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/FiniteScaleListCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.MapDefinition
{
- public partial class FiniteScaleListCtrl : UserControl
+ internal partial class FiniteScaleListCtrl : UserControl
{
internal FiniteScaleListCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/GroupPropertiesCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/GroupPropertiesCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/GroupPropertiesCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.MapDefinition
{
- public partial class GroupPropertiesCtrl : UserControl
+ internal partial class GroupPropertiesCtrl : UserControl
{
private GroupPropertiesCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/LayerPropertiesCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/LayerPropertiesCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/LayerPropertiesCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.MapDefinition
{
- public partial class LayerPropertiesCtrl : UserControl
+ internal partial class LayerPropertiesCtrl : UserControl
{
private LayerPropertiesCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/ManualScaleEditor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/ManualScaleEditor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/ManualScaleEditor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.MapDefinition
{
- public partial class ManualScaleEditor : Form
+ internal partial class ManualScaleEditor : Form
{
private ManualScaleEditor()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapDefinitionEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapDefinitionEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapDefinitionEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,8 +28,14 @@
namespace Maestro.Editors.MapDefinition
{
+ /// <summary>
+ /// Editor control for Map Definitions
+ /// </summary>
public partial class MapDefinitionEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="MapDefinitionEditorCtrl"/> class.
+ /// </summary>
public MapDefinitionEditorCtrl()
{
InitializeComponent();
@@ -38,6 +44,12 @@
private IMapDefinition _map;
private IEditorService _edSvc;
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
_edSvc = service;
Modified: sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapLayersSectionCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapLayersSectionCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/MapDefinition/MapLayersSectionCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,6 +34,9 @@
namespace Maestro.Editors.MapDefinition
{
+ /// <summary>
+ ///
+ /// </summary>
public delegate void OpenLayerEventHandler(object sender, string layerResourceId);
[ToolboxItem(true)]
Modified: sandbox/maestro-3.0/Maestro.Editors/Migration/CopyMoveToServerDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Migration/CopyMoveToServerDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Migration/CopyMoveToServerDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,6 +29,9 @@
namespace Maestro.Editors.Migration
{
+ /// <summary>
+ /// A dialog to specify options for copying/moving resources to another connection
+ /// </summary>
public partial class CopyMoveToServerDialog : Form
{
private CopyMoveToServerDialog()
@@ -40,6 +43,11 @@
private IServerConnection _source;
private IServerConnection _target;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CopyMoveToServerDialog"/> class.
+ /// </summary>
+ /// <param name="source">The source.</param>
+ /// <param name="target">The target.</param>
public CopyMoveToServerDialog(IServerConnection source, IServerConnection target)
: this()
{
@@ -108,12 +116,20 @@
this.DialogResult = DialogResult.Cancel;
}
+ /// <summary>
+ /// Gets or sets the target folder.
+ /// </summary>
+ /// <value>The target folder.</value>
public string TargetFolder
{
get { return txtTargetFolder.Text; }
set { txtTargetFolder.Text = value; }
}
+ /// <summary>
+ /// Gets or sets the source resource ids.
+ /// </summary>
+ /// <value>The source resource ids.</value>
public string[] SourceResourceIds
{
get
@@ -136,12 +152,20 @@
}
}
+ /// <summary>
+ /// Gets or sets the selected action.
+ /// </summary>
+ /// <value>The selected action.</value>
public MigrationAction SelectedAction
{
get { return (MigrationAction)cmbAction.SelectedItem; }
set { cmbAction.SelectedItem = value ; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [overwrite resources].
+ /// </summary>
+ /// <value><c>true</c> if [overwrite resources]; otherwise, <c>false</c>.</value>
public bool OverwriteResources
{
get { return chkOverwrite.Checked; }
@@ -167,9 +191,18 @@
}
}
+ /// <summary>
+ /// Defines the valid migration actions
+ /// </summary>
public enum MigrationAction
- {
+ {
+ /// <summary>
+ ///
+ /// </summary>
Copy,
+ /// <summary>
+ ///
+ /// </summary>
Move
}
}
Modified: sandbox/maestro-3.0/Maestro.Editors/Migration/MigrateDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/Migration/MigrateDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/Migration/MigrateDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,6 +30,9 @@
namespace Maestro.Editors.Migration
{
+ /// <summary>
+ /// A dialog to specify resource migration settings
+ /// </summary>
public partial class MigrateDialog : Form
{
private MigrateDialog()
@@ -40,6 +43,11 @@
private IServerConnection _source;
private IServerConnection _target;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="MigrateDialog"/> class.
+ /// </summary>
+ /// <param name="source">The source.</param>
+ /// <param name="target">The target.</param>
public MigrateDialog(IServerConnection source, IServerConnection target)
: this()
{
@@ -47,12 +55,20 @@
_target = target;
}
+ /// <summary>
+ /// Gets or sets the resource ID.
+ /// </summary>
+ /// <value>The resource ID.</value>
public string ResourceID
{
get { return txtResourceId.Text; }
set { txtResourceId.Text = value; }
}
+ /// <summary>
+ /// Gets or sets the dependent resources.
+ /// </summary>
+ /// <value>The dependent resources.</value>
public string[] DependentResources
{
get
@@ -85,6 +101,10 @@
}
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [overwrite existing].
+ /// </summary>
+ /// <value><c>true</c> if [overwrite existing]; otherwise, <c>false</c>.</value>
public bool OverwriteExisting
{
get { return chkOverwrite.Checked; }
Modified: sandbox/maestro-3.0/Maestro.Editors/PrintLayout/LogoDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/PrintLayout/LogoDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/PrintLayout/LogoDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,7 +31,7 @@
namespace Maestro.Editors.PrintLayout
{
- public partial class LogoDialog : Form
+ internal partial class LogoDialog : Form
{
private LogoDialog()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/PrintLayout/PrintLayoutEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/PrintLayout/PrintLayoutEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/PrintLayout/PrintLayoutEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,13 +27,23 @@
namespace Maestro.Editors.PrintLayout
{
+ /// <summary>
+ /// Editor control for print layouts
+ /// </summary>
public partial class PrintLayoutEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PrintLayoutEditorCtrl"/> class.
+ /// </summary>
public PrintLayoutEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Binds the specified service.
+ /// </summary>
+ /// <param name="service">The service.</param>
public override void Bind(IEditorService service)
{
printSettingsCtrl.Bind(service);
Modified: sandbox/maestro-3.0/Maestro.Editors/PrintLayout/TextDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/PrintLayout/TextDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/PrintLayout/TextDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,7 +27,7 @@
namespace Maestro.Editors.PrintLayout
{
- public partial class TextDialog : Form
+ internal partial class TextDialog : Form
{
public TextDialog()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/CommandIconCache.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/CommandIconCache.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/CommandIconCache.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -25,7 +25,7 @@
namespace Maestro.Editors.WebLayout
{
- public static class CommandIconCache
+ internal static class CommandIconCache
{
public static Bitmap GetStandardCommandIcon(BuiltInCommandType cmdType)
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeScriptCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeScriptCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeScriptCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.WebLayout.Commands
{
- public partial class InvokeScriptCtrl : UserControl
+ internal partial class InvokeScriptCtrl : UserControl
{
public InvokeScriptCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeURLCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeURLCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/InvokeURLCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Editors.WebLayout.Commands
{
- public partial class InvokeURLCtrl : EditorBase
+ internal partial class InvokeURLCtrl : EditorBase
{
public InvokeURLCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/SearchCmdCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/SearchCmdCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/Commands/SearchCmdCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,7 +34,7 @@
namespace Maestro.Editors.WebLayout.Commands
{
- public partial class SearchCmdCtrl : EditorBase
+ internal partial class SearchCmdCtrl : EditorBase
{
public SearchCmdCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/CustomCommandPropertyCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/CustomCommandPropertyCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/CustomCommandPropertyCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.WebLayout
{
- public partial class CustomCommandPropertyCtrl : EditorBase
+ internal partial class CustomCommandPropertyCtrl : EditorBase
{
public CustomCommandPropertyCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/MenuEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/MenuEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/MenuEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -30,7 +30,7 @@
namespace Maestro.Editors.WebLayout
{
- public partial class MenuEditorCtrl : EditorBase
+ internal partial class MenuEditorCtrl : EditorBase
{
public MenuEditorCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutCommandsCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutCommandsCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutCommandsCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -32,7 +32,7 @@
namespace Maestro.Editors.WebLayout
{
[ToolboxItem(true)]
- public partial class WebLayoutCommandsCtrl : EditorBindableCollapsiblePanel
+ internal partial class WebLayoutCommandsCtrl : EditorBindableCollapsiblePanel
{
public WebLayoutCommandsCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutEditorCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutEditorCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutEditorCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,13 +28,25 @@
namespace Maestro.Editors.WebLayout
{
+ /// <summary>
+ /// Editor control for Web Layouts
+ /// </summary>
public partial class WebLayoutEditorCtrl : EditorBase
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="WebLayoutEditorCtrl"/> class.
+ /// </summary>
public WebLayoutEditorCtrl()
{
InitializeComponent();
}
+ /// <summary>
+ /// Sets the initial state of this editor and sets up any databinding
+ /// within such that user interface changes will propagate back to the
+ /// model.
+ /// </summary>
+ /// <param name="service"></param>
public override void Bind(IEditorService service)
{
webLayoutSettingsCtrl.Bind(service);
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutMenusCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutMenusCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutMenusCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -33,7 +33,7 @@
namespace Maestro.Editors.WebLayout
{
[ToolboxItem(true)]
- public partial class WebLayoutMenusCtrl : EditorBindableCollapsiblePanel
+ internal partial class WebLayoutMenusCtrl : EditorBindableCollapsiblePanel
{
public WebLayoutMenusCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutSettingsCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutSettingsCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Editors/WebLayout/WebLayoutSettingsCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,7 +34,7 @@
namespace Maestro.Editors.WebLayout
{
[ToolboxItem(true)]
- public partial class WebLayoutSettingsCtrl : EditorBindableCollapsiblePanel
+ internal partial class WebLayoutSettingsCtrl : EditorBindableCollapsiblePanel
{
public WebLayoutSettingsCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Login/HttpLoginCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/HttpLoginCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/HttpLoginCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,7 +28,7 @@
namespace Maestro.Login
{
- public partial class HttpLoginCtrl : UserControl, ILoginCtrl
+ internal partial class HttpLoginCtrl : UserControl, ILoginCtrl
{
private bool _loading = true;
Modified: sandbox/maestro-3.0/Maestro.Login/ILoginCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/ILoginCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/ILoginCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -23,15 +23,38 @@
namespace Maestro.Login
{
+ /// <summary>
+ /// Login control interface
+ /// </summary>
public interface ILoginCtrl
{
+ /// <summary>
+ /// Gets the username.
+ /// </summary>
+ /// <value>The username.</value>
string Username { get; }
+ /// <summary>
+ /// Gets the password.
+ /// </summary>
+ /// <value>The password.</value>
string Password { get; }
+ /// <summary>
+ /// Updates the login status.
+ /// </summary>
void UpdateLoginStatus();
+ /// <summary>
+ /// Occurs when [enable ok].
+ /// </summary>
event EventHandler EnableOk;
+ /// <summary>
+ /// Occurs when [disabled ok].
+ /// </summary>
event EventHandler DisabledOk;
+ /// <summary>
+ /// Occurs when [check saved password].
+ /// </summary>
event EventHandler CheckSavedPassword;
}
}
Modified: sandbox/maestro-3.0/Maestro.Login/LocalNativeLoginCtrl.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/LocalNativeLoginCtrl.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/LocalNativeLoginCtrl.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,7 +29,7 @@
namespace Maestro.Login
{
- public partial class LocalNativeLoginCtrl : UserControl, ILoginCtrl
+ internal partial class LocalNativeLoginCtrl : UserControl, ILoginCtrl
{
public LocalNativeLoginCtrl()
{
Modified: sandbox/maestro-3.0/Maestro.Login/LoginDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/LoginDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/LoginDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,6 +29,9 @@
namespace Maestro.Login
{
+ /// <summary>
+ /// A dialog to prompt for <see cref="OSGeo.MapGuide.MaestroAPI.IServerConnection"/> information
+ /// </summary>
public partial class LoginDialog : Form
{
private int _selectedIndex;
@@ -40,6 +43,9 @@
private HttpLoginCtrl _http;
private LocalNativeLoginCtrl _local;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="LoginDialog"/> class.
+ /// </summary>
public LoginDialog()
{
InitializeComponent();
@@ -58,16 +64,28 @@
_controls[1].DisabledOk += OnDisableOk;
}
+ /// <summary>
+ /// Gets the username.
+ /// </summary>
+ /// <value>The username.</value>
public string Username
{
get { return _controls[_selectedIndex].Username; }
}
+ /// <summary>
+ /// Gets the password.
+ /// </summary>
+ /// <value>The password.</value>
public string Password
{
get { return _controls[_selectedIndex].Password; }
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.Form.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
_siteList = PreferredSiteList.Load();
@@ -122,11 +140,19 @@
btnOK.Enabled = false;
}
+ /// <summary>
+ /// Gets the connection.
+ /// </summary>
+ /// <value>The connection.</value>
public IServerConnection Connection
{
get { return _conn; }
}
+ /// <summary>
+ /// Sets the login control.
+ /// </summary>
+ /// <param name="c">The c.</param>
public void SetLoginControl(Control c)
{
loginPanel.Controls.Clear();
@@ -222,7 +248,7 @@
}
_siteList.Save();
}
- catch (Exception ex)
+ catch (Exception)
{
}
Modified: sandbox/maestro-3.0/Maestro.Login/PreferedSite.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/PreferedSite.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/PreferedSite.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -40,6 +40,10 @@
private int m_windowHeight;
private string m_guiLanguage;
+ /// <summary>
+ /// Gets or sets the sites.
+ /// </summary>
+ /// <value>The sites.</value>
public PreferedSite[] Sites
{
get
@@ -51,6 +55,10 @@
set { m_sites = value; }
}
+ /// <summary>
+ /// Gets or sets the GUI language.
+ /// </summary>
+ /// <value>The GUI language.</value>
[System.Xml.Serialization.XmlAttribute()]
public string GUILanguage
{
@@ -58,6 +66,10 @@
set { m_guiLanguage = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [use fusion preview].
+ /// </summary>
+ /// <value><c>true</c> if [use fusion preview]; otherwise, <c>false</c>.</value>
[System.Xml.Serialization.XmlAttribute()]
public bool UseFusionPreview
{
@@ -65,6 +77,10 @@
set { m_useFusionPreview = value; }
}
+ /// <summary>
+ /// Gets or sets the system browser.
+ /// </summary>
+ /// <value>The system browser.</value>
[System.Xml.Serialization.XmlAttribute()]
public string SystemBrowser
{
@@ -86,6 +102,10 @@
}
+ /// <summary>
+ /// Gets or sets the prefered site.
+ /// </summary>
+ /// <value>The prefered site.</value>
[System.Xml.Serialization.XmlAttribute()]
public int PreferedSite
{
@@ -93,6 +113,10 @@
set { m_initialSite = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [auto connect].
+ /// </summary>
+ /// <value><c>true</c> if [auto connect]; otherwise, <c>false</c>.</value>
[System.Xml.Serialization.XmlAttribute()]
public bool AutoConnect
{
@@ -100,6 +124,10 @@
set { m_autoconnect = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [maximized window].
+ /// </summary>
+ /// <value><c>true</c> if [maximized window]; otherwise, <c>false</c>.</value>
[System.Xml.Serialization.XmlAttribute()]
public bool MaximizedWindow
{
@@ -107,6 +135,10 @@
set { m_maximizedWindow = value; }
}
+ /// <summary>
+ /// Gets or sets the window left.
+ /// </summary>
+ /// <value>The window left.</value>
[System.Xml.Serialization.XmlAttribute()]
public int WindowLeft
{
@@ -114,6 +146,10 @@
set { m_windowLeft = value; }
}
+ /// <summary>
+ /// Gets or sets the window top.
+ /// </summary>
+ /// <value>The window top.</value>
[System.Xml.Serialization.XmlAttribute()]
public int WindowTop
{
@@ -121,6 +157,10 @@
set { m_windowTop = value; }
}
+ /// <summary>
+ /// Gets or sets the width of the window.
+ /// </summary>
+ /// <value>The width of the window.</value>
[System.Xml.Serialization.XmlAttribute()]
public int WindowWidth
{
@@ -128,6 +168,10 @@
set { m_windowWidth = value; }
}
+ /// <summary>
+ /// Gets or sets the height of the window.
+ /// </summary>
+ /// <value>The height of the window.</value>
[System.Xml.Serialization.XmlAttribute()]
public int WindowHeight
{
@@ -135,6 +179,10 @@
set { m_windowHeight = value; }
}
+ /// <summary>
+ /// Adds the site.
+ /// </summary>
+ /// <param name="site">The site.</param>
public void AddSite(PreferedSite site)
{
//A generic collection would be nice :/
@@ -162,6 +210,10 @@
}
}
+ /// <summary>
+ /// Loads the preferred site list
+ /// </summary>
+ /// <returns></returns>
public static PreferredSiteList Load()
{
try
@@ -180,6 +232,9 @@
return new PreferredSiteList();
}
+ /// <summary>
+ /// Saves this instance.
+ /// </summary>
public void Save()
{
System.Xml.Serialization.XmlSerializer sz = new System.Xml.Serialization.XmlSerializer(typeof(PreferredSiteList));
@@ -225,46 +280,77 @@
private bool m_savePassword;
private Version m_approvedVersion;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="PreferedSite"/> class.
+ /// </summary>
public PreferedSite()
{
}
+ /// <summary>
+ /// Gets or sets the site URL.
+ /// </summary>
+ /// <value>The site URL.</value>
public string SiteURL
{
get { return m_siteURL; }
set { m_siteURL = value; }
}
+ /// <summary>
+ /// Gets or sets the starting point.
+ /// </summary>
+ /// <value>The starting point.</value>
public string StartingPoint
{
get { return m_startingPoint; }
set { m_startingPoint = value; }
}
+ /// <summary>
+ /// Gets or sets the username.
+ /// </summary>
+ /// <value>The username.</value>
public string Username
{
get { return m_username; }
set { m_username = value; }
}
+ /// <summary>
+ /// Gets or sets the scrambled password.
+ /// </summary>
+ /// <value>The scrambled password.</value>
public string ScrambledPassword
{
get { return m_scrambledPassword; }
set { m_scrambledPassword = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether [save password].
+ /// </summary>
+ /// <value><c>true</c> if [save password]; otherwise, <c>false</c>.</value>
public bool SavePassword
{
get { return m_savePassword; }
set { m_savePassword = value; }
}
+ /// <summary>
+ /// Gets or sets the approved version string.
+ /// </summary>
+ /// <value>The approved version string.</value>
public string ApprovedVersionString
{
get { return ApprovedVersion.ToString(); }
set { ApprovedVersion = new Version(value); }
}
+ /// <summary>
+ /// Gets or sets the approved version.
+ /// </summary>
+ /// <value>The approved version.</value>
[System.Xml.Serialization.XmlIgnore()]
public Version ApprovedVersion
{
@@ -277,6 +363,10 @@
set { m_approvedVersion = value; }
}
+ /// <summary>
+ /// Gets or sets the unscrambled password.
+ /// </summary>
+ /// <value>The unscrambled password.</value>
[System.Xml.Serialization.XmlIgnore()]
public string UnscrambledPassword
{
@@ -285,6 +375,12 @@
}
+ /// <summary>
+ /// Returns a <see cref="System.String"/> that represents this instance.
+ /// </summary>
+ /// <returns>
+ /// A <see cref="System.String"/> that represents this instance.
+ /// </returns>
public override string ToString()
{
return m_siteURL;
Modified: sandbox/maestro-3.0/Maestro.Login/WaitCursor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Login/WaitCursor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Login/WaitCursor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -31,6 +31,10 @@
private Form m_owner = null;
private Cursor m_oldcursor;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="WaitCursor"/> class.
+ /// </summary>
+ /// <param name="owner">The owner.</param>
public WaitCursor(Form owner)
{
//This ensures that nested WaitCursors behave as expected.
@@ -45,6 +49,9 @@
#region IDisposable Members
+ /// <summary>
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+ /// </summary>
public void Dispose()
{
//If we are the the outermost WaitCursor, reset the cursor
Modified: sandbox/maestro-3.0/Maestro.Packaging/PackageBuilder.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Packaging/PackageBuilder.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Packaging/PackageBuilder.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -89,6 +89,9 @@
/// <param name="resourceId">The name of the resource being processed, if any</param>
public delegate void ProgressDelegate(ProgressType type, string resourceId, int maxValue, int value);
+ /// <summary>
+ /// A class to create MapGuide data packages
+ /// </summary>
public class PackageBuilder
{
/// <summary>
Modified: sandbox/maestro-3.0/Maestro.Packaging/PackageProgress.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Packaging/PackageProgress.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Packaging/PackageProgress.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -28,6 +28,9 @@
namespace Maestro.Packaging
{
+ /// <summary>
+ /// Progress dialog for packaging operations
+ /// </summary>
public partial class PackageProgress : Form
{
/// <summary>
Modified: sandbox/maestro-3.0/Maestro.Packaging/ResourceDataItem.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Packaging/ResourceDataItem.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Packaging/ResourceDataItem.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,6 +34,13 @@
private string m_dataType;
private EntryTypeEnum m_entryType;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceDataItem"/> class.
+ /// </summary>
+ /// <param name="resourceName">Name of the resource.</param>
+ /// <param name="contentType">Type of the content.</param>
+ /// <param name="filename">The filename.</param>
+ /// <param name="dataType">Type of the data.</param>
public ResourceDataItem(string resourceName, string contentType, string filename, string dataType)
{
m_resourceName = resourceName;
@@ -43,6 +50,10 @@
m_entryType = EntryTypeEnum.Regular;
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceDataItem"/> class.
+ /// </summary>
+ /// <param name="rdi">The rdi.</param>
public ResourceDataItem(ResourceDataItem rdi)
{
m_resourceName = rdi.m_resourceName;
@@ -52,30 +63,50 @@
m_entryType = rdi.m_entryType;
}
+ /// <summary>
+ /// Gets or sets the name of the resource.
+ /// </summary>
+ /// <value>The name of the resource.</value>
public string ResourceName
{
get { return m_resourceName; }
set { m_resourceName = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the content.
+ /// </summary>
+ /// <value>The type of the content.</value>
public string ContentType
{
get { return m_contentType; }
set { m_contentType = value; }
}
+ /// <summary>
+ /// Gets or sets the filename.
+ /// </summary>
+ /// <value>The filename.</value>
public string Filename
{
get { return m_filename; }
set { m_filename = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the entry.
+ /// </summary>
+ /// <value>The type of the entry.</value>
public EntryTypeEnum EntryType
{
get { return m_entryType; }
set { m_entryType = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the data.
+ /// </summary>
+ /// <value>The type of the data.</value>
public string DataType
{
get { return m_dataType; }
Modified: sandbox/maestro-3.0/Maestro.Packaging/ResourceItem.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Packaging/ResourceItem.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Packaging/ResourceItem.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,6 +29,12 @@
public class ResourceItem
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceItem"/> class.
+ /// </summary>
+ /// <param name="resourcePath">The resource path.</param>
+ /// <param name="headerPath">The header path.</param>
+ /// <param name="contentPath">The content path.</param>
public ResourceItem(string resourcePath, string headerPath, string contentPath)
{
m_originalResourcePath = m_resourcePath = resourcePath;
@@ -39,6 +45,10 @@
m_isFolder = m_originalResourcePath.EndsWith("/");
}
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ResourceItem"/> class.
+ /// </summary>
+ /// <param name="ri">The ri.</param>
public ResourceItem(ResourceItem ri)
{
m_originalResourcePath = ri.m_originalResourcePath;
@@ -60,18 +70,30 @@
private List<ResourceDataItem> m_items;
private bool m_isFolder;
+ /// <summary>
+ /// Gets or sets a value indicating whether this instance is folder.
+ /// </summary>
+ /// <value><c>true</c> if this instance is folder; otherwise, <c>false</c>.</value>
public bool IsFolder
{
get { return m_isFolder; }
set { m_isFolder = true; }
}
+ /// <summary>
+ /// Gets or sets the items.
+ /// </summary>
+ /// <value>The items.</value>
public List<ResourceDataItem> Items
{
get { return m_items; }
set { m_items = value; }
}
+ /// <summary>
+ /// Gets or sets the type of the entry.
+ /// </summary>
+ /// <value>The type of the entry.</value>
public EntryTypeEnum EntryType
{
get { return m_entryType; }
@@ -79,24 +101,40 @@
}
+ /// <summary>
+ /// Gets or sets the original resource path.
+ /// </summary>
+ /// <value>The original resource path.</value>
public string OriginalResourcePath
{
get { return m_originalResourcePath; }
set { m_originalResourcePath = value; }
}
+ /// <summary>
+ /// Gets or sets the resource path.
+ /// </summary>
+ /// <value>The resource path.</value>
public string ResourcePath
{
get { return m_resourcePath; }
set { m_resourcePath = value; }
}
+ /// <summary>
+ /// Gets or sets the contentpath.
+ /// </summary>
+ /// <value>The contentpath.</value>
public string Contentpath
{
get { return m_contentpath; }
set { m_contentpath = value; }
}
+ /// <summary>
+ /// Gets or sets the headerpath.
+ /// </summary>
+ /// <value>The headerpath.</value>
public string Headerpath
{
get { return m_headerpath; }
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/CancelException.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/CancelException.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/CancelException.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -4,6 +4,9 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// Thrown when a lengthy operation is cancelled.
+ /// </summary>
[global::System.Serializable]
public class CancelException : Exception
{
@@ -14,9 +17,32 @@
// http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncscol/html/csharp07192001.asp
//
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CancelException"/> class.
+ /// </summary>
public CancelException() { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CancelException"/> class.
+ /// </summary>
+ /// <param name="message">The message.</param>
public CancelException(string message) : base(message) { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CancelException"/> class.
+ /// </summary>
+ /// <param name="message">The message.</param>
+ /// <param name="inner">The inner.</param>
public CancelException(string message, Exception inner) : base(message, inner) { }
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CancelException"/> class.
+ /// </summary>
+ /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ /// <exception cref="T:System.ArgumentNullException">
+ /// The <paramref name="info"/> parameter is null.
+ /// </exception>
+ /// <exception cref="T:System.Runtime.Serialization.SerializationException">
+ /// The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
+ /// </exception>
protected CancelException(
System.Runtime.Serialization.SerializationInfo info,
System.Runtime.Serialization.StreamingContext context)
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/CheckBoxBinder.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/CheckBoxBinder.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/CheckBoxBinder.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,7 +34,12 @@
// on loss of focus.
// http://stackoverflow.com/questions/1060080/databound-winforms-control-does-not-recognize-change-until-losing-focus
-
+ /// <summary>
+ /// Binds the specified checkbox
+ /// </summary>
+ /// <param name="chk"></param>
+ /// <param name="b"></param>
+ /// <returns></returns>
public static Binding BindChecked(CheckBox chk, Binding b)
{
chk.DataBindings.Add(b);
@@ -43,6 +48,13 @@
return b;
}
+ /// <summary>
+ /// Binds the specified checkbox
+ /// </summary>
+ /// <param name="chk"></param>
+ /// <param name="dataSource"></param>
+ /// <param name="dataMember"></param>
+ /// <returns></returns>
public static Binding BindChecked(CheckBox chk, object dataSource, string dataMember)
{
var binding = chk.DataBindings.Add("Checked", dataSource, dataMember);
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/CollapsiblePanel.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/CollapsiblePanel.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/CollapsiblePanel.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -43,11 +43,18 @@
[ToolboxItem(false)]
public partial class CollapsiblePanel : UserControl
{
+ /// <summary>
+ /// Initializes a new instance of the <see cref="CollapsiblePanel"/> class.
+ /// </summary>
protected CollapsiblePanel()
{
InitializeComponent();
}
+ /// <summary>
+ /// Raises the <see cref="E:System.Windows.Forms.UserControl.Load"/> event.
+ /// </summary>
+ /// <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
protected override void OnLoad(EventArgs e)
{
base.OnLoad(e);
@@ -55,6 +62,10 @@
btnExpand.Enabled = this.Collapsed;
}
+ /// <summary>
+ /// Gets or sets the color of the header background.
+ /// </summary>
+ /// <value>The color of the header background.</value>
[Category("Collapsible Panel Header")]
public Color HeaderBackgroundColor
{
@@ -62,6 +73,10 @@
set { headerPanel.BackColor = value; }
}
+ /// <summary>
+ /// Gets or sets the header text.
+ /// </summary>
+ /// <value>The header text.</value>
[Category("Collapsible Panel Header")]
public string HeaderText
{
@@ -69,6 +84,10 @@
set { lblHeaderText.Text = value; }
}
+ /// <summary>
+ /// Gets or sets the header font.
+ /// </summary>
+ /// <value>The header font.</value>
[Category("Collapsible Panel Header")]
public Font HeaderFont
{
@@ -76,6 +95,10 @@
set { lblHeaderText.Font = value; }
}
+ /// <summary>
+ /// Gets or sets the color of the content background.
+ /// </summary>
+ /// <value>The color of the content background.</value>
[Category("Collapsible Panel Content")]
public Color ContentBackgroundColor
{
@@ -83,6 +106,12 @@
set { contentPanel.BackColor = value; }
}
+ /// <summary>
+ /// Gets or sets a value indicating whether this instance can collapse.
+ /// </summary>
+ /// <value>
+ /// <c>true</c> if this instance can collapse; otherwise, <c>false</c>.
+ /// </value>
[DefaultValue(true)]
[Category("Collapsible Panel")]
public bool CanCollapse
@@ -93,6 +122,10 @@
private bool _collapsed;
+ /// <summary>
+ /// Gets or sets a value indicating whether this <see cref="CollapsiblePanel"/> is collapsed.
+ /// </summary>
+ /// <value><c>true</c> if collapsed; otherwise, <c>false</c>.</value>
[DefaultValue(false)]
[Category("Collapsible Panel")]
public bool Collapsed
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/ComboBoxBinder.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/ComboBoxBinder.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/ComboBoxBinder.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,6 +34,12 @@
// on loss of focus.
// http://stackoverflow.com/questions/1060080/databound-winforms-control-does-not-recognize-change-until-losing-focus
+ /// <summary>
+ /// Binds the specified combobox
+ /// </summary>
+ /// <param name="cmb"></param>
+ /// <param name="b"></param>
+ /// <returns></returns>
public static Binding BindSelectedIndexChanged(ComboBox cmb, Binding b)
{
cmb.DataBindings.Add(b);
@@ -42,6 +48,14 @@
return b;
}
+ /// <summary>
+ /// Binds the specified combobox
+ /// </summary>
+ /// <param name="cmb"></param>
+ /// <param name="cmbProperty"></param>
+ /// <param name="dataSource"></param>
+ /// <param name="dataMember"></param>
+ /// <returns></returns>
public static Binding BindSelectedIndexChanged(ComboBox cmb, string cmbProperty, object dataSource, string dataMember)
{
var binding = cmb.DataBindings.Add(cmbProperty, dataSource, dataMember);
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/Maestro.Shared.UI.csproj
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/Maestro.Shared.UI.csproj 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/Maestro.Shared.UI.csproj 2010-10-27 09:53:07 UTC (rev 5341)
@@ -29,6 +29,7 @@
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
+ <DocumentationFile>..\SDK\bin\Release\Maestro.Shared.UI.XML</DocumentationFile>
</PropertyGroup>
<ItemGroup>
<Reference Include="System" />
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/NumericBinder.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/NumericBinder.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/NumericBinder.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,7 +34,12 @@
// on loss of focus.
// http://stackoverflow.com/questions/1060080/databound-winforms-control-does-not-recognize-change-until-losing-focus
-
+ /// <summary>
+ /// Binds the specified NumericUpDown control
+ /// </summary>
+ /// <param name="num"></param>
+ /// <param name="b"></param>
+ /// <returns></returns>
public static Binding BindValueChanged(NumericUpDown num, Binding b)
{
num.DataBindings.Add(b);
@@ -43,6 +48,13 @@
return b;
}
+ /// <summary>
+ /// Binds the specified NumericUpDown control
+ /// </summary>
+ /// <param name="num"></param>
+ /// <param name="dataSource"></param>
+ /// <param name="dataMember"></param>
+ /// <returns></returns>
public static Binding BindValueChanged(NumericUpDown num, object dataSource, string dataMember)
{
var binding = num.DataBindings.Add("Value", dataSource, dataMember);
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/ProgressDialog.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/ProgressDialog.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/ProgressDialog.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -27,8 +27,14 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// Generic progress dialog
+ /// </summary>
public partial class ProgressDialog : Form
{
+ /// <summary>
+ ///
+ /// </summary>
public delegate object DoBackgroundWork(BackgroundWorker worker, DoWorkEventArgs e, params object[] args);
private DoBackgroundWork m_method;
@@ -38,6 +44,9 @@
private System.Threading.Thread m_worker;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ProgressDialog"/> class.
+ /// </summary>
public ProgressDialog()
{
InitializeComponent();
@@ -52,6 +61,13 @@
set { m_cancelAborts = value; }
}
+ /// <summary>
+ /// Runs the operation async.
+ /// </summary>
+ /// <param name="owner">The owner.</param>
+ /// <param name="method">The method.</param>
+ /// <param name="arguments">The arguments.</param>
+ /// <returns></returns>
public object RunOperationAsync(Form owner, DoBackgroundWork method, params object[] arguments)
{
m_method = method;
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/TextBoxBinder.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/TextBoxBinder.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/TextBoxBinder.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -34,6 +34,12 @@
// on loss of focus.
// http://stackoverflow.com/questions/1060080/databound-winforms-control-does-not-recognize-change-until-losing-focus
+ /// <summary>
+ /// Binds the specified text box
+ /// </summary>
+ /// <param name="txt"></param>
+ /// <param name="b"></param>
+ /// <returns></returns>
public static Binding BindText(TextBoxBase txt, Binding b)
{
txt.DataBindings.Add(b);
@@ -42,6 +48,13 @@
return b;
}
+ /// <summary>
+ /// Binds the specified text box
+ /// </summary>
+ /// <param name="txt"></param>
+ /// <param name="dataSource"></param>
+ /// <param name="dataMember"></param>
+ /// <returns></returns>
public static Binding BindText(TextBoxBase txt, object dataSource, string dataMember)
{
var binding = txt.DataBindings.Add("Text", dataSource, dataMember);
Modified: sandbox/maestro-3.0/Maestro.Shared.UI/WaitCursor.cs
===================================================================
--- sandbox/maestro-3.0/Maestro.Shared.UI/WaitCursor.cs 2010-10-27 09:00:54 UTC (rev 5340)
+++ sandbox/maestro-3.0/Maestro.Shared.UI/WaitCursor.cs 2010-10-27 09:53:07 UTC (rev 5341)
@@ -24,11 +24,19 @@
namespace Maestro.Shared.UI
{
+ /// <summary>
+ /// Helper class to set a control's cursor to busy during the lifetime of this
+ /// object
+ /// </summary>
public class WaitCursor : IDisposable
{
private Control _owner;
private Cursor _orig;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="WaitCursor"/> class.
+ /// </summary>
+ /// <param name="owner">The owner.</param>
public WaitCursor(Control owner)
{
_owner = owner;
@@ -36,6 +44,9 @@
_owner.Cursor = Cursors.WaitCursor;
}
+ /// <summary>
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+ /// </summary>
public void Dispose()
{
_owner.Cursor = _orig;
More information about the mapguide-commits
mailing list