.. include:: headings.inc

.. currentmodule:: lib.masked.maskededit

.. highlight:: python



.. _lib.masked.maskededit.Field:

==========================================================================================================================================
|phoenix_title|  **Field**
==========================================================================================================================================

This class manages the individual fields in a masked edit control.
Each field has a zero-based index, indicating its position in the
control, an extent, an associated mask, and a plethora of optional
parameters.  Fields can be instantiated and then associated with
parent masked controls, in order to provide field-specific configuration.
Alternatively, fields will be implicitly created by the parent control
if not provided at construction, at which point, the fields can then
manipulated by the controls .SetFieldParameters() method.



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **Field**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.masked.maskededit.Field_inheritance.png" alt="Inheritance diagram of Field" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.masked.maskededit.Field.html" title="This class manages the individual fields in a masked edit control." alt="" coords="5,5,149,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.masked.maskededit.Field.__init__`                                    This is the "constructor" for setting up parameters for fields.
:meth:`~lib.masked.maskededit.Field.IsEmpty`                                     Indicates whether the specified slice is considered empty for the
:meth:`~lib.masked.maskededit.Field.IsValid`                                     Indicates whether the specified slice is considered a valid value for the
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: Field

   This class manages the individual fields in a masked edit control.
   Each field has a zero-based index, indicating its position in the
   control, an extent, an associated mask, and a plethora of optional
   parameters.  Fields can be instantiated and then associated with
   parent masked controls, in order to provide field-specific configuration.
   Alternatively, fields will be implicitly created by the parent control
   if not provided at construction, at which point, the fields can then
   manipulated by the controls .SetFieldParameters() method.

   .. method:: __init__(self, \*\*kwargs)

      This is the "constructor" for setting up parameters for fields.
      a field_index of -1 is used to indicate "the entire control."


   .. method:: IsEmpty(self, slice)

      Indicates whether the specified slice is considered empty for the
      field.


   .. method:: IsValid(self, slice)

      Indicates whether the specified slice is considered a valid value for the
      field.