MODIFY LABEL Command

Opens the Label Designer to create or modify a label.

MODIFY LABEL [FileName | ?] 
   [[WINDOW WindowName1] [IN [WINDOW] WindowName2 | IN SCREEN]] 
   [NOENVIRONMENT] [NOWAIT] [PROTECTED] [SAVE]

Parameters

  • [FileName | ?]
    Specifies the file name for the label or displays the Open dialog box so you can select an existing label file or type the name of the label file to create. The default file name extension for labels is .lbx.

    Note

    If the label file you specify does not exist or cannot be found, MODIFY LABEL creates a new label file. Calling MODIFY LABEL without arguments displays the Open dialog box. Choosing New opens the Label Designer and creates a new label file with the default name of LabelNumber. When you close the Label Designer, Visual FoxPro prompts you to save changes to the label and provide a different name.

  • [[WINDOW WindowName1]
    Specifies a window whose characteristics the Label Designer inherits.

    For example, if the window specified was created with the FLOAT option of DEFINE WINDOW, you can move the Label Designer. The specified window must be defined, but it does not need to be active or visible.

    Note

    The Label Designer has a default size that can be larger than the specified window. In this case, the Label Designer still inherits the characteristics of the window with the upper-left corner of the Label Designer placed at the same coordinates as the upper-left corner of the specified window but extends beyond the specified window's borders.

  • [IN [WINDOW] WindowName2 | IN SCREEN]]
    Specifies opening the Label Designer in a parent window or in the main Visual FoxPro window after placing the Label Designer in a parent window. The Label Designer does not assume the characteristics of the parent window and cannot move outside the parent window. If the parent window is moved, the Label Designer moves with it.

    Note

    You must first define the parent window using DEFINE WINDOW and make it visible for access by the Label Designer.

  • [NOENVIRONMENT]
    Prevents saving the Visual FoxPro data environment with the label and is included for backward compatibility with 2.x labels. For more information, see Controlling Data in Reports.

    Tip

    You can restore the data environment associated with a Visual FoxPro label by setting the data environment's AutoOpenTables property to True (.T.). To make sure that the label environment closes when the label finishes printing, set the AutoCloseTables property to True (.T.). For more information, see AutoOpenTables Property and AutoCloseTables Property.

  • [NOWAIT]
    Continues program execution after the Label Designer opens. The program does not wait for the Label Designer to close but continues program execution on the immediate following line. If you omit NOWAIT, the Label Designer opens, and program execution pauses until the Label Designer closes.

    When calling MODIFY LABEL with NOWAIT in the Command window, NOWAIT has no effect.

  • [PROTECTED]
    Specifies that the Label Designer should open in “protected” mode, which disables or suppresses certain features of the Designer. Intended to be used in applications to expose end-user editing of label forms in a safer, controlled fashion where some potentially harmful editing actions cannot take place.

  • [SAVE]
    Specifies that the Label Designer remain open after activating another window. If you omit SAVE, the Label Designer closes when you activate another window.

    When calling MODIFY LABEL with SAVE in the Command window, SAVE has no effect.

Remarks

You can edit labels using the Visual FoxPro user interface. For more information, see How to: Open Reports and Labels. You can also create labels using a wizard. For more information, see How to: Create Labels.

See Also

Reference

Label Designer

LABEL Command

CREATE LABEL Command

Other Resources

Working with Reports

Commands (Visual FoxPro)