如何使用自定义 UITypeEditor C# WindowsFormApplication 在设计时保存集合数据?
How to save collection data in Design Time with Custom UITypeEditor C# WindowsFormApplication?
我编写了自己的 UITypeEditor,并在@Sefe 和 THIS link 的帮助下实现了我的目标。
我的基本设置:
在此设置中,BaseForm
扩展了 System.Windows.Forms.Form
。我在这里放置了我的 属性 (List<Control> ActionButtons
),它有一个像模式样式一样的自定义 UITypeEditor。
恢复工作流(所有这里都在设计时):
1 - 打开我的表格。
2 - 单击 MyForm 属性面板上的 ActionButtons(由 BaseForm 继承)省略号 [...]。
3 - 打开一个自定义表单,其中包含我想要挑选的膨胀对象。 (此表单由我的 CustomUITypeEditor 调用)
4 - 选取我想要的对象,然后关闭表单。所以现在,数据在 MyForm
中是可以的,并序列化到 Designer.cs 文件中。我可以重新打开该 EditorUI,再次单击省略号并查看我之前选择的对象。
5 - 现在当我关闭 MyForm 并重新打开它时,所有数据都丢失了!!!但是数据还是序列化成了Designer.cs。
6 - 如果我使用 string
而不是 List<Control>
执行所有这些步骤,一切都可以。
下面是我的代码:
public class CollectionTypeEditor : UITypeEditor {
private IWindowsFormsEditorService _editorService = null;
private ICollection<Control> mControls = null;
private List<Control> mPickedControls = null;
// Editor like Modal style
public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) {
return UITypeEditorEditStyle.Modal;
}
// Opens modal and get returned data
public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) {
if (provider == null)
return value;
_editorService = (IWindowsFormsEditorService) provider
.GetService(typeof(IWindowsFormsEditorService));
if (_editorService == null)
return value;
mControls = new List<Control>();
// retrieve old data
mPickedControls = value as List<Control>;
if (mPickedControls == null)
mPickedControls = new List<Control>();
// getting existent controls that will be inflated in modal
Control mContext = (Control) context.Instance;
GetControls(mContext);
// open form and get response
CollectionDesign<Control> frmCollections = new CollectionDesign<Control>(mControls, ref mPickedControls);
var response = _editorService.ShowDialog(frmCollections);
// returning data from editor
return response == DialogResult.OK ? mPickedControls : value;
}
这里一切正常。 BaseForm
中我的变量代码。 Ps.: 这个变量将显示在 MyForm
上,我在其中单击省略号 [...]
[Editor(typeof(CollectionTypeEditor), typeof(UITypeEditor))]
[TypeConverter(typeof(ActionButtonConverter))]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
public List<Control> ActionButtons { get; set; }
由于无法保存文件,添加了序列化属性。关闭并重新打开表单时,所有数据都将丢失。
奇怪的是,我用 相同的方式 编写了其他 UITypeEditor,只是将数据类型更改为 string
,我可以关闭或重新打开我的表单和所有工作正常,数据已保存。
我已经添加了一个 TypeConverter,但我认为这里不是这种情况。我的代码有什么问题?
我在重新打开表单时收到此错误:
Severity Code Description Project File Line Suppression State Message Method 'System.CodeDom.CodePropertyReferenceExpression.Add' not found.
更新
现在我的控件列表在关闭或重新打开时存储在 myForm.designer 文件中,但控件不会附加到 属性 网格上。即:如果我在关闭并重新打开 myForm 时单击省略号添加按钮 'addbt',代码将自动生成。
myForm.designer 上自动生成的代码:
//
// addbt
//
this.addbt.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right)));
this.addbt.Cursor = System.Windows.Forms.Cursors.Hand;
this.addbt.Font = new System.Drawing.Font("Tahoma", 9F);
this.addbt.ForeColor = System.Drawing.Color.FromArgb(((int)(((byte)(222)))), ((int)(((byte)(0)))), ((int)(((byte)(0)))), ((int)(((byte)(0)))));
this.addbt.Location = new System.Drawing.Point(13, 6);
this.addbt.Name = "addbt";
this.addbt.Size = new System.Drawing.Size(103, 33);
this.addbt.TabIndex = 0;
this.addbt.Text = "Incluir";
this.addbt.UseVisualStyleBackColor = true;
//
// myForm
//
this.ActionButtons.Add(this.addbt);
如果我再次单击省略号,数据将附加到 myForm 的 PropertyGrid 上的 属性。但是当我重新打开 myForm 时,之前存储的这个值不会传递到 myForm 的 PropertyGrid 上的 属性(数据仍然存储在自动生成的代码设计器中)。因此,当单击省略号 [...] 时,value
from EditValue
方法不会随数据一起存储。我觉得它更近了:)
也许我下面的 TypeConverter 有问题:
public class ActionButtonConverter : TypeConverter {
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) {
if (sourceType == (typeof(string)))
return true;
return base.CanConvertFrom(context, sourceType);
}
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) {
if(value.GetType() == typeof(string)) {
List<Control> ctrs = value as List<Control>;
if (ctrs != null)
return ctrs;
}
return base.ConvertFrom(context, culture, value);
}
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) {
if (destinationType == typeof(string))
return true;
return base.CanConvertTo(context, destinationType);
}
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) {
if (value == null)
return "null";
if (destinationType == typeof(string))
return "(custom collection)";
return base.ConvertTo(context, culture, value, destinationType);
}
我认为我在反序列化中有任何错误。当 myForm 重新打开时,ITypeDescriptorContext 或值 (TypeConverter) 没有任何关于序列化数据到 designer.cs 文件中的任何信息。
谢谢大家,抱歉语言不好:P
WinForms 设计时支持是一个棘手的主题。为了更好地理解:所发生的是正在设计的表单被转换为代码。此过程称为设计时序列化。序列化由 CodeDomSerializer
, which can be applied to the property with a DesignerSerializerAttribute
执行。您可以在表单的 auto-generated 文件中查看生成的代码。当您进行 WinForms 设计时开发时,您有时必须检查序列化器输出(在 FormName.Designer.cs 文件中)。我确定在您的情况下不会有将控件添加到容器控件的输出(否则关闭和重新打开表单不会有问题)。
默认序列化程序可以处理大多数序列化情况,主要是在 TypeConverter
的帮助下。因此,您通常 不必创建自己的序列化程序,但有时您必须这样做。你的情况就是这样。
您添加到 post 的错误消息是 CodeDom 错误消息,因此它肯定来自序列化程序,因为这是我们创建源代码的地方。我认为您在这种特殊情况下的问题是您没有将新项目添加到您的列表中,而是将其他控件添加到您的表单中。通常,默认序列化程序将为 collection 中的每个元素创建一个新项。但是,这不是您需要在此处执行的操作,因为您想要将 existing 项目添加到 collection(这就是它与 string
一起使用的原因,因为它总是可以创建一个文字)。
您的解决方案是创建自己的 CodeDomSerializer
,通过 design-time 架构查找添加的控件(您可能需要 IReferenceService
)并添加 CodeDom 图将现有项目添加到您的 collection.
例如,默认序列化程序创建的代码如下所示:
this.myControl.ActionButtons.Add(new Button());
您的代码必须如下所示:
this.myControl.ActionButtons.Add(this.myActionButton);
这意味着首先使用 IReferenceService
获取您的按钮的名称(您在 collection 中只有 object),然后创建一个 CodeDom 图,将此按钮添加到你的 属性。为此,你将不得不覆盖 CodeDomSerializer.SerializeProperty
并拦截你的 ActionButtons
属性 的序列化(一定要为所有其他属性调用基础 class),你可以在哪里做你的连载。
几天后我找到了这个问题的解决方案。我解决了它创建我自己的 Button 集合继承 CollectionBase:
public class ButtonCollection : CollectionBase {
public CustomButton this[int i] {
get { return InnerList[i] as CustomButton; }
set { InnerList[i] = value; }
}
public ButtonCollection() {
}
public CustomButton Add(CustomButton bt) {
InnerList.Add(bt);
return bt;
}
public void AddRange(CustomButton[] bts) {
InnerList.AddRange(bts);
}
public void Remove(CustomButton bt) {
InnerList.Remove(bt);
}
public bool Contains(CustomButton bt) {
return InnerList.Contains(bt);
}
public CustomButton[] GetValues() {
CustomButton[] bts = new CustomButton[InnerList.Count];
InnerList.CopyTo(bts);
return bts;
}
我还对 TypeConverter 进行了更改:
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo info, object value, Type destType) {
if ((destType == typeof(string)) && (value is CustomButton)) {
CustomButton bt = (CustomButton) value;
return bt.Name;
}
// this helped me a lot
// here the object needs to know how to create itself
// Type[0] can be overridden by Type[] { (your constructor parameterTypes) }
// null can be overridden by objects that will be passed how parameter
// third parameter is a value indicating if the initialization of the object is or not complete
else if (destType == typeof(InstanceDescriptor)) {
return new InstanceDescriptor(
typeof(CustomButton).GetConstructor(new Type[0]),
null,
false
);
}
return base.ConvertTo(context, info, value, destType);
}
TypeConverter 装饰器传递给 CustomButton
class:
[TypeConverter(typeof(CustomButtonConverter))]
public class CustomButton {
...
我根据可以找到的自定义 collectionsEditor 的完整示例完成了所有这些 here。
我编写了自己的 UITypeEditor,并在@Sefe 和 THIS link 的帮助下实现了我的目标。
我的基本设置:
在此设置中,BaseForm
扩展了 System.Windows.Forms.Form
。我在这里放置了我的 属性 (List<Control> ActionButtons
),它有一个像模式样式一样的自定义 UITypeEditor。
恢复工作流(所有这里都在设计时):
1 - 打开我的表格。
2 - 单击 MyForm 属性面板上的 ActionButtons(由 BaseForm 继承)省略号 [...]。
3 - 打开一个自定义表单,其中包含我想要挑选的膨胀对象。 (此表单由我的 CustomUITypeEditor 调用)
4 - 选取我想要的对象,然后关闭表单。所以现在,数据在 MyForm
中是可以的,并序列化到 Designer.cs 文件中。我可以重新打开该 EditorUI,再次单击省略号并查看我之前选择的对象。
5 - 现在当我关闭 MyForm 并重新打开它时,所有数据都丢失了!!!但是数据还是序列化成了Designer.cs。
6 - 如果我使用 string
而不是 List<Control>
执行所有这些步骤,一切都可以。
下面是我的代码:
public class CollectionTypeEditor : UITypeEditor {
private IWindowsFormsEditorService _editorService = null;
private ICollection<Control> mControls = null;
private List<Control> mPickedControls = null;
// Editor like Modal style
public override UITypeEditorEditStyle GetEditStyle(ITypeDescriptorContext context) {
return UITypeEditorEditStyle.Modal;
}
// Opens modal and get returned data
public override object EditValue(ITypeDescriptorContext context, IServiceProvider provider, object value) {
if (provider == null)
return value;
_editorService = (IWindowsFormsEditorService) provider
.GetService(typeof(IWindowsFormsEditorService));
if (_editorService == null)
return value;
mControls = new List<Control>();
// retrieve old data
mPickedControls = value as List<Control>;
if (mPickedControls == null)
mPickedControls = new List<Control>();
// getting existent controls that will be inflated in modal
Control mContext = (Control) context.Instance;
GetControls(mContext);
// open form and get response
CollectionDesign<Control> frmCollections = new CollectionDesign<Control>(mControls, ref mPickedControls);
var response = _editorService.ShowDialog(frmCollections);
// returning data from editor
return response == DialogResult.OK ? mPickedControls : value;
}
这里一切正常。 BaseForm
中我的变量代码。 Ps.: 这个变量将显示在 MyForm
上,我在其中单击省略号 [...]
[Editor(typeof(CollectionTypeEditor), typeof(UITypeEditor))]
[TypeConverter(typeof(ActionButtonConverter))]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
public List<Control> ActionButtons { get; set; }
由于无法保存文件,添加了序列化属性。关闭并重新打开表单时,所有数据都将丢失。
奇怪的是,我用 相同的方式 编写了其他 UITypeEditor,只是将数据类型更改为 string
,我可以关闭或重新打开我的表单和所有工作正常,数据已保存。
我已经添加了一个 TypeConverter,但我认为这里不是这种情况。我的代码有什么问题?
我在重新打开表单时收到此错误:
Severity Code Description Project File Line Suppression State Message Method 'System.CodeDom.CodePropertyReferenceExpression.Add' not found.
更新
现在我的控件列表在关闭或重新打开时存储在 myForm.designer 文件中,但控件不会附加到 属性 网格上。即:如果我在关闭并重新打开 myForm 时单击省略号添加按钮 'addbt',代码将自动生成。
myForm.designer 上自动生成的代码:
//
// addbt
//
this.addbt.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Bottom | System.Windows.Forms.AnchorStyles.Right)));
this.addbt.Cursor = System.Windows.Forms.Cursors.Hand;
this.addbt.Font = new System.Drawing.Font("Tahoma", 9F);
this.addbt.ForeColor = System.Drawing.Color.FromArgb(((int)(((byte)(222)))), ((int)(((byte)(0)))), ((int)(((byte)(0)))), ((int)(((byte)(0)))));
this.addbt.Location = new System.Drawing.Point(13, 6);
this.addbt.Name = "addbt";
this.addbt.Size = new System.Drawing.Size(103, 33);
this.addbt.TabIndex = 0;
this.addbt.Text = "Incluir";
this.addbt.UseVisualStyleBackColor = true;
//
// myForm
//
this.ActionButtons.Add(this.addbt);
如果我再次单击省略号,数据将附加到 myForm 的 PropertyGrid 上的 属性。但是当我重新打开 myForm 时,之前存储的这个值不会传递到 myForm 的 PropertyGrid 上的 属性(数据仍然存储在自动生成的代码设计器中)。因此,当单击省略号 [...] 时,value
from EditValue
方法不会随数据一起存储。我觉得它更近了:)
也许我下面的 TypeConverter 有问题:
public class ActionButtonConverter : TypeConverter {
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) {
if (sourceType == (typeof(string)))
return true;
return base.CanConvertFrom(context, sourceType);
}
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value) {
if(value.GetType() == typeof(string)) {
List<Control> ctrs = value as List<Control>;
if (ctrs != null)
return ctrs;
}
return base.ConvertFrom(context, culture, value);
}
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType) {
if (destinationType == typeof(string))
return true;
return base.CanConvertTo(context, destinationType);
}
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType) {
if (value == null)
return "null";
if (destinationType == typeof(string))
return "(custom collection)";
return base.ConvertTo(context, culture, value, destinationType);
}
我认为我在反序列化中有任何错误。当 myForm 重新打开时,ITypeDescriptorContext 或值 (TypeConverter) 没有任何关于序列化数据到 designer.cs 文件中的任何信息。
谢谢大家,抱歉语言不好:P
WinForms 设计时支持是一个棘手的主题。为了更好地理解:所发生的是正在设计的表单被转换为代码。此过程称为设计时序列化。序列化由 CodeDomSerializer
, which can be applied to the property with a DesignerSerializerAttribute
执行。您可以在表单的 auto-generated 文件中查看生成的代码。当您进行 WinForms 设计时开发时,您有时必须检查序列化器输出(在 FormName.Designer.cs 文件中)。我确定在您的情况下不会有将控件添加到容器控件的输出(否则关闭和重新打开表单不会有问题)。
默认序列化程序可以处理大多数序列化情况,主要是在 TypeConverter
的帮助下。因此,您通常 不必创建自己的序列化程序,但有时您必须这样做。你的情况就是这样。
您添加到 post 的错误消息是 CodeDom 错误消息,因此它肯定来自序列化程序,因为这是我们创建源代码的地方。我认为您在这种特殊情况下的问题是您没有将新项目添加到您的列表中,而是将其他控件添加到您的表单中。通常,默认序列化程序将为 collection 中的每个元素创建一个新项。但是,这不是您需要在此处执行的操作,因为您想要将 existing 项目添加到 collection(这就是它与 string
一起使用的原因,因为它总是可以创建一个文字)。
您的解决方案是创建自己的 CodeDomSerializer
,通过 design-time 架构查找添加的控件(您可能需要 IReferenceService
)并添加 CodeDom 图将现有项目添加到您的 collection.
例如,默认序列化程序创建的代码如下所示:
this.myControl.ActionButtons.Add(new Button());
您的代码必须如下所示:
this.myControl.ActionButtons.Add(this.myActionButton);
这意味着首先使用 IReferenceService
获取您的按钮的名称(您在 collection 中只有 object),然后创建一个 CodeDom 图,将此按钮添加到你的 属性。为此,你将不得不覆盖 CodeDomSerializer.SerializeProperty
并拦截你的 ActionButtons
属性 的序列化(一定要为所有其他属性调用基础 class),你可以在哪里做你的连载。
几天后我找到了这个问题的解决方案。我解决了它创建我自己的 Button 集合继承 CollectionBase:
public class ButtonCollection : CollectionBase {
public CustomButton this[int i] {
get { return InnerList[i] as CustomButton; }
set { InnerList[i] = value; }
}
public ButtonCollection() {
}
public CustomButton Add(CustomButton bt) {
InnerList.Add(bt);
return bt;
}
public void AddRange(CustomButton[] bts) {
InnerList.AddRange(bts);
}
public void Remove(CustomButton bt) {
InnerList.Remove(bt);
}
public bool Contains(CustomButton bt) {
return InnerList.Contains(bt);
}
public CustomButton[] GetValues() {
CustomButton[] bts = new CustomButton[InnerList.Count];
InnerList.CopyTo(bts);
return bts;
}
我还对 TypeConverter 进行了更改:
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo info, object value, Type destType) {
if ((destType == typeof(string)) && (value is CustomButton)) {
CustomButton bt = (CustomButton) value;
return bt.Name;
}
// this helped me a lot
// here the object needs to know how to create itself
// Type[0] can be overridden by Type[] { (your constructor parameterTypes) }
// null can be overridden by objects that will be passed how parameter
// third parameter is a value indicating if the initialization of the object is or not complete
else if (destType == typeof(InstanceDescriptor)) {
return new InstanceDescriptor(
typeof(CustomButton).GetConstructor(new Type[0]),
null,
false
);
}
return base.ConvertTo(context, info, value, destType);
}
TypeConverter 装饰器传递给 CustomButton
class:
[TypeConverter(typeof(CustomButtonConverter))]
public class CustomButton {
...
我根据可以找到的自定义 collectionsEditor 的完整示例完成了所有这些 here。