.. include:: ../../../Includes.txt


.. _reference-optgroup:

========
OPTGROUP
========

The OPTGROUP element allows authors to group choices logically. This is
particularly helpful when the user must choose from a long list of options;
groups of related choices are easier to grasp and remember than a single
long list of options. All OPTGROUP elements must be specified directly
within a SELECT element (i.e., groups may not be nested).

An OPTGROUP object can only exist between a SELECT object.


.. _reference-optgroup-1-2-3-4:

1, 2, 3, 4 ...
==============

:aspect:`Property:`
    1, 2, 3, 4 ...

:aspect:`Data type:`
    [array of FORM objects]

:aspect:`Description:`
    OPTION objects, part of the OPTGROUP


.. _reference-optgroup-class:

class
=====

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-class`.


.. _reference-optgroup-disabled:

disabled
========

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-disabled`.


.. _reference-optgroup-id:

id
==

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-id`.


.. _reference-optgroup-label:

label
=====

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-label`.

:aspect:`Default:`
    optgroup


.. _reference-optgroup-lang:

lang
====

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-lang`.


.. _reference-optgroup-layout:

layout
======

:aspect:`Description:`
    See general information for :ref:`reference-layout` and the :ref:`reference-layout-optgroup`
    specific information.


.. _reference-optgroup-style:

style
=====

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-style`.


.. _reference-optgroup-title:

title
=====

:aspect:`Description:`
    See general information for  :ref:`reference-objects-attributes-title`.

[tsref:(cObject).FORM.FormObject.OPTGROUP]

