CutCopyMaskFormat Property

Gets or sets a value that determines whether literals and prompt characters are copied to the clipboard.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<RefreshPropertiesAttribute(RefreshProperties.Repaint)>
<DefaultValueAttribute()>
<SRCategoryAttribute("Behavior")>
<SRDescriptionAttribute("Indicates whether the text to be copied to the clipboard includes literals and/or prompt characters.")>
Public Property CutCopyMaskFormat As MaskFormat

Dim instance As MaskedTextBoxCell
Dim value As MaskFormat
 
instance.CutCopyMaskFormat = value
 
value = instance.CutCopyMaskFormat

[RefreshProperties(RefreshProperties.Repaint)]
[DefaultValue()]
[SRCategory("Behavior")]
[SRDescription("Indicates whether the text to be copied to the clipboard includes literals and/or prompt characters.")]
public MaskFormat CutCopyMaskFormat {get; set;}

Property Value

One of the System.Windows.Forms.MaskFormat values. The default is System.Windows.Forms.MaskFormat.IncludeLiterals.

Exceptions

Exception	Description
System.ComponentModel.InvalidEnumArgumentException	The specified value is not a System.Windows.Forms.MaskFormat value.

Remarks

The CutCopyMaskFormat property determines how text is interpreted when it is copied to the clipboard. Specifically, it determines whether literal characters, prompt characters, or both are included when text is accessed. When prompt characters are excluded, they are transformed into spaces in the copied string.

The TextMaskFormat property serves a similar purpose with respect to how the text is interpreted.

Example

This example sets the CutCopyMaskFormat property.

GrapeCity.Win.MultiRow.MaskedTextBoxCell mcell = new GrapeCity.Win.MultiRow.MaskedTextBoxCell();
//Type a number
mcell.Mask = "000-0000";
mcell.AllowPromptAsInput = false;
mcell.CutCopyMaskFormat = MaskFormat.IncludePromptAndLiterals;
GrapeCity.Win.MultiRow.TextBoxCell text2 = new GrapeCity.Win.MultiRow.TextBoxCell();
text2.Name = "text2";
GrapeCity.Win.MultiRow.Template template1 = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(new GrapeCity.Win.MultiRow.Cell[] { mcell, text2 }, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader | GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber);
template1.ColumnHeaders[0].Cells[0].Value = "Column1";
template1.ColumnHeaders[0].Cells[1].Value = "Column2";
gcMultiRow1.Template = template1;
gcMultiRow1.RowCount = 3;

VB.NET

Dim mcell As New GrapeCity.Win.MultiRow.MaskedTextBoxCell()
'Type a number
mcell.Mask = "000-0000"
mcell.AllowPromptAsInput = False
mcell.CutCopyMaskFormat = MaskFormat.IncludePromptAndLiterals
Dim text2 As New GrapeCity.Win.MultiRow.TextBoxCell()
text2.Name = "text2"
Dim template1 As GrapeCity.Win.MultiRow.Template = GrapeCity.Win.MultiRow.Template.CreateGridTemplate(New GrapeCity.Win.MultiRow.Cell() {mcell, text2}, 160, GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.ColumnHeader Or GrapeCity.Win.MultiRow.AutoGenerateGridTemplateStyles.RowHeaderAutoNumber)
template1.ColumnHeaders(0).Cells(0).Value = "Column1"
template1.ColumnHeaders(0).Cells(1).Value = "Column2"
GcMultiRow1.Template = template1
GcMultiRow1.RowCount = 3

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

MaskedTextBoxCell Class
MaskedTextBoxCell Members