Font Property, SftMask Object

Defines the font used to display text while editing.

Syntax

Get

C#	System.Drawing.Font refFontObj = object.Font;
VB.NET	refFontObj = object.Font As System.Drawing.Font
C++	IFontDisp* refFontObj = object->GetFont();
C	HRESULT object->get_Font(IFontDisp** refFontObj);

Put

C#	void object.let_Font(System.Drawing.Font refFontObj);
VB.NET	object.let_Font(ByVal refFontObj As System.Drawing.Font)
C++	void object->PutFont(IFontDisp* refFontObj);
C	HRESULT object->put_Font(IFontDisp* refFontObj);

PutRef

C#	System.Drawing.Font object.Font = refFontObj;
VB.NET	object.Font = refFontObj As System.Drawing.Font
C++	void object->PutRefFont(IFontDisp* refFontObj);
C	HRESULT object->putref_Font(IFontDisp* refFontObj);

object

A SftMask object.

refFontObj

Defines the font used to display text while editing.

Comments

The Font property defines the font used to display text while editing.

The PromptUnderline and PromptUnderlineNoFocus properties can be used to further underline input fields using the defined font, allowing users to distinguish between input fields and literal characters.

The font used for the caption is defined using the Caption.Font property.

If the AutoSize property is set to True, the height of the control is automatically adjusted to allow the complete text to be displayed without being clipped vertically.

Using PutRef (see Syntax above) the control will use the reference to the Font object. If the Font object is later changed, this will also affect the font used by the control. Using Put instead, causes the control to create a copy of the Font object. If the Font object is later changed, this will not affect the font used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of Put, PutRef is the preferred method.

Examples

C# View entire sample code

private void Form1_Load(object sender, System.EventArgs e)
{
    Font BoldFont = new Font("Times New Roman", 12, FontStyle.Bold);
    axSftMask1.Font = BoldFont;
    Font NormFont = new Font("Times New Roman", 12, FontStyle.Regular);
    axSftMask1.Caption.Font = OLECvt.ToIFontDisp(NormFont);

    SftMaskCalculator CalcObj = axSftMask1.Calculator;

    axSftMask1.Caption.SizePercent = 33;
    axSftMask1.Caption.Text = "&Amount:";
    axSftMask1.Mask = "| $C-,8.2";
    axSftMask1.Alignment = SftMaskAlignConstants.alignSftMaskRight;
    axSftMask1.EntrySelect = SftMaskEntrySelectConstants.entrySftMaskSelectEnd;
    axSftMask1.Text = "10";

VB.NET View entire sample code

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    Dim BoldFont As New Font("Times New Roman", 12, FontStyle.Bold)
    AxSftMask1.Font = BoldFont
    Dim NormFont As New Font("Times New Roman", 12, FontStyle.Regular)
    AxSftMask1.Caption.Font = OLECvt.ToIFontDisp(NormFont)

    Dim CalcObj As SftMaskCalculator
    AxSftMask1.Caption.SizePercent = 33
    AxSftMask1.Caption.Text = "&Amount:"
    AxSftMask1.Mask = "| $C-,8.2"
    AxSftMask1.Alignment = SftMaskAlignConstants.alignSftMaskRight
    AxSftMask1.EntrySelect = SftMaskEntrySelectConstants.entrySftMaskSelectEnd
    AxSftMask1.Text = 10
    CalcObj = AxSftMask1.Calculator
    CalcObj.Lines = 12
    CalcObj.FracDigits = 2

C++ View entire sample code

BOOL CProject1Dlg::OnInitDialog()
{
    CDialog::OnInitDialog();

    m_pMask1 = m_Mask1.GetControlUnknown();
    _ASSERT(m_pMask1 != NULL);

    IFontDispPtr pFontDisp = m_pMask1->GetFont();
    IFontPtr pFont = pFontDisp;
    pFont->put_Name(L"Times New Roman");
    pFont->put_Bold(TRUE);
    CY size;
    size.int64 = 12*10000L; //12 point font
    pFont->put_Size(size);

    pFontDisp = m_pMask1->Caption->GetFont();

See Also SftMask Object | Object Hierarchy