combit List & Label 27 - .NET Help
combit.Reporting Namespace / ListLabel Class
Properties Methods Events

In This Topic
    ListLabel Class Members
    In This Topic

    The following tables list the members exposed by ListLabel.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public Property

    If true, variables are also offered as content for table fields.

     
    Public PropertySets the progress box type for the databound mode.  
    Public PropertyIf this property is set to TRUE, a Designer Preview is available in databound mode.  
    Public Property

    Sets the print destination for the methods Print and Design in databound mode, e.g. printer, preview, PDF, HTML, etc.

     
    Public PropertySets the title for the print options dialog for the methods Print and Design in databound mode.  
    Public PropertyGets or sets whether it is possible to create a new project file for the method Design in databound mode.  
    Public PropertySets the type of data transfer for the methods Print and Design in databound mode.  
    Public Property

    Sets the file name of the List & Label project file for the methods Print and Design in databound mode.

     
    Public PropertySets project type for the methods Print and Design in databound mode (List, Card, Label).  
    Public PropertyGets or sets whether the print options dialog should be displayed at print start for the method Print in databound mode. Enables the user to select a different print option.  
    Public PropertyGets or sets whether the file selection dialog with integrated preview window should be displayed for the methods Print and Design in databound mode. Enables the user to select a different project file.  
    Public PropertyGets or sets whether the preview file is stored in a compressed format.  
    Public PropertyGets or sets whether CR-LF combinations in field and variable contents are changed to LF. This setting prevents doubled line feeds.  
    Public Property

    Different available data binding modes.

     
    Public Property

    Defines the "main" table and has the effect that only this table and all linked child tables are offered. Tables which are located above the specified table in the hierarchy will be hid. Set this property to empty (String.Empty) if you want to have all tables available generally.

    Use the AutoMasterMode Property to choose if the data of the DataMember should be transferred as fields (e.g. for an invoice list) or as variables (e.g. invoice collection).

     
    Public Property

    DataSource to use for the Print Method and Design Method. You can bind to any data for which a provider is available. See the combit.Reporting.DataProviders Namespace for an overview of available data providers. You may also write your own data provider and in this way bind to custom sources not covered yet. The most frequently used objects for data binding are

     
    Public PropertySets the debug mode. You may "or" multiple options like "LlDebug.Enabled | LlDebug.LogToFile".  
    Public PropertyIf this property set to true the header of a table will only be printed if data for the table is supplied.  
    Public PropertyAllows adding menu entries and buttons to the Designer's toolbar.  
    Public PropertyCollection of custom designer functions.  
    Public PropertyCollection of custom designer objects.  
    Public PropertySets the dialog box style for List & Label.  
    Public Property

    Gets or sets a container for the external files that a List & Label project depends on, e.g. drilldown projects, includes, images, shapefiles, etc. A repository can only be set once per instance!

    When a file repository is assigned, external files will be referenced via an ID instead of a file path and the file selection dialogs will be replaced with dialogs that allow choosing and adding virtual files from/to the repository. Use a repository in situations where you want to reuse resources easily across several reports or where includes from local file paths are troublesome (e.g. in web applications).

    For more information see also IRepository.

     
    Public PropertyWhen using fonts with extreme descent the descent is added to the line height if this option is set to true.  
    Public PropertyGets or sets if the preview will be displayed as soon as the first page is available (True, default) or after all pages have been rendered (False).  
    Public Property

    Sets the language for the configuration dialogs. You might have to purchase one of the optionally available language kits in order to set the language of your choice.

    Please note that setting this property results in closing and re-opening the underlying List & Label job. All defined variables, fields etc. will be reset by this action. You should set this property as early as possible, ideally right after constructing an instance of the component.

     
    Public Property

    Enter your personal license information here.

    Be sure to set this property as soon as the List & Label object has been created so that the edition type used is known. Information about your personal license key can be found in the PersonalLicense.txt file.

    Important: Must be set before redistribution.

     
    Public Property

    This option is used to set the maximum number of attempts to print an object. Useful to prevent endless loops if non-wrappable content is exceeding the available space. Default '0' means 'no limit'.

     
    Public Property

    List & Label uses the Windows RTF control. As there are different versions of this control, List & Label has to know which version to use. With this property you provide the maximum version number for List & Label to use.

    0x100: Version 1.0

    0x200: Version 2.0

    ...

    Please note that setting this property results in closing and re-opening the underlying List & Label job. All defined variables, fields etc. will be reset by this action. You should set this property as early as possible, ideally right after constructing an instance of the component.

     
    Public PropertyList & Label usually checks all function parameters for validity. You may switch off this check by setting this property to true. This can provide a higher printing speed.  
    Public PropertyGets or sets the ListLabelPreviewControl used for printing (see AutoDestination Property)  
    Public Property

    Initial real data preview zoom factor in percent. (Default: 100; 100 represents the page width)

     
    Public Property

    If true, List & Label uses a virtual device for the rendering. This means that no printer driver is required and used on the system. Note that this may have a minimal impact on the positioning of the output.

    If false, List & Label uses the printer (drivers) installed in the system for rendering (default).

     
    Public PropertySets a password for encryption of the project file. If empty, no encryption is used.  
    Public PropertyThis property sets the table coloring mode.  
    Public PropertySets the smallest length unit by List & Label.  
    Public PropertyIf set to true, variable and field names are treated case sensitive.  
    Top
    Public Methods
     NameDescription
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. 

    This key method handles the databound call to the Designer. Assign a DataSource to the component and call this method to start a print job. The overloads allow to fine tune the behavior by suppressing the file dialog, preset the project file name etc. You may also use the Auto... properties (e.g. AutoProjectFile Property) to modify these settings.

     
    Public Method (Inherited from System.ComponentModel.Component)
    Public MethodIf you want to carry out evaluations on the basis of an existing instance of the ListLabel component, simply use the EvaluateExpression method.  
    Public Method

    This key method handles the databound export to one of the available export formats. Assign a DataSource to the component and call this method to start an export. Export options not available in the ExportConfiguration Class can be added via the ExportOptions Property.

     
    Public Method (Inherited from System.MarshalByRefObject)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. 

    This key method handles the databound printing. Assign a DataSource to the component and call this method to start a print job. The overloads allow to fine tune the behavior by suppressing the file dialog, the print option dialog, preset the project file name etc. You may also use the Auto... properties (e.g. AutoProjectFile Property) to modify these settings.

     
    Public MethodOverloaded. 

    Sets the data source and data member to use for the Print Method and Design Method. You can bind to any data for which a provider is available. See the combit.Reporting.DataProviders Namespace for an overview of available data providers. You may also write your own data provider and in this way bind to custom sources not covered yet. The most frequently used objects for data binding are

     
    Public Method (Inherited from System.ComponentModel.Component)
    Top
    Public Events
     NameDescription
    Public Event

    This event is called when using data binding for all automatically declared fields. With the event arguments you can manipulate the name and content or completely prevent the declaration of the element.

     
    Public Event

    Similar to AutoDefineNewPage, this event is called when printing databound lists for every row of a table before calling LlPrintFields. Here, you can declare additional fields that you would like to use in the table. Make sure that you pass all field names in the form of "<tableid>.<fieldname>" in order to enable List & Label can connect these to their corresponding table (e.g. "Orders.OrderID").

     
    Public Event

    The event is triggered for every new page when using data binding. Here, you can register additional required variables for this page. The event is called internally before calling LlPrint.

     
    Public Event

    This event is called when using data binding for each automatically declared table. With the event arguments you can completely prevent the declaration of the element.

     
    Public Event

    This event is called when using data binding for each automatically declared table relation. Can be used for suppressing the relation.

     
    Public Event

    This event is called when using data binding for each automatically declared table sort order. With the event arguments you can completely prevent the declaration of the element.

     
    Public Event

    This event is called when using data binding for all automatically declared variables. With the event arguments you can manipulate the name and content or completely prevent the declaration of the element.

     
    Public Event  
    Public Event

    This event can be used to set additional options to be used for print/export.

    Internally, the event is triggered after the print/export process is started; but before the actual printing starts. This allows you to define various export options using the ExportOptions property or set special print options using LlPrintSetOption and LlPrintOption.

     
    Public EventThis event is triggered to display the real data preview or export in the Designer. If you use databinding, you don't need to implement a handler for this event - the databinding engine does this automatically for you. See the DesignerPreview-Sample for an example how to implement your own handler for this event.  
    Public Event

    The event DrawObject is called for each object displayed by List & Label. The event arguments provide a Graphics object as well as the rectangle of the object.

     
    Public Event

    This event is called in the case of list projects for each displayed page and allows customized drawing with GDI+.

     
    Public Event

    With the help of this event, you can print additional drawings and elements for label and card projects. This allows customized printing. For instance, you can apply a watermark from your product's demo version to each print out.

     
    Public Event

    Similar to DrawTableLine, this event can be used to apply a different color to each field of a table.

     
    Public Event

    This event allows the modification of a table line. In this way, you can, for instance, create a customized colored and, if necessary, an alternating background (which List & Label provides too, but there might be reasons to paint it in this event).

     
    Public Event

    With this event you can indicate which menu items are allowed in the designer. For this, you must use the corresponding Win API functions that can be passed to the menu handle contained in the event arguments.

     
    Public Event

    The Designer function External$ allows offering of external functions in the List & Label formula assistant. Whenever the user uses this function, the Evaluate event is called, which evaluates the formula and returns the result or an error message. Usually it is preferable to use the DesignerFunction Class for custom functions.

     
    Public Event

    This event is triggered when an expression error occurs in a project. The passed error texts can be concatenated and then displayed to the user.

     
    Public Event  
    Public Event

    This event allows modification of List & Label menus. The event arguments are identical to those of EnableMenu.

     
    Public Event

    This event is called if AutoProjectFile contains more than one project file separated by semicolons. In this case, a sequence print is triggered and this event allows to change options between two print jobs of the sequence.

     
    Public Event  
    Public EventThis event is triggered by the databinding engine to notify the application of the print progress. It can be used e.g. to refresh a progress meter is a status bar. Be aware that the event might be raised from another thread and synchronize calls to UI elements.  
    Public Event

    This event is triggered after a page is exported.

     
    Public Event  
    Public Event

    Can be used to supervise a print job after it is passed to the spooler.

     
    Public Event

    This event is called whenever text is printed. Use it for preprocessing, e.g. hyphenation.

     
    Public EventThis event is triggered whenever a project is loaded in the Designer. It allows your application to keep track of the most recently used files.  
    Public Event

    This event is triggered after all report parameters have been prepared. The available choices may be retrieved, and the parameter values may be changed in this event by using the DOM.

     
    Public Event

    This event is triggered after all report parameters have been collected and the user has confirmed the selected values.

     
    Public Event  
    Public Event

    This event will be fired every time a project is saved in the List & Label designer. Thus your application can react if a new project is created or an existing one is saved.

     
    Public Event  
    Public Event

    This event is triggered as soon as a menu or toolbar item is clicked. You have the option to let the call be processed as usual or execute an alternative function.

     
    Public Event

    This event allows the integration of a customized Help system. For this, the event arguments contain the corresponding context ID. If you implement customized Help, you must indicate this to List & Label, so that the internal Help is not displayed.

     
    Public Event

    You can support your users by displaying help texts for each variable and field. The event is triggered for the corresponding element as soon as the user selects it in the formula assistant and the help text is to be displayed.

     
    Public Event

    This event is called when certain actions (print, export, fax, mail) have been executed in the preview window.

     
    Public Event

    This event is triggered when a button in the preview window is clicked. Here, you have the option to implement the corresponding function by yourself or accept the regular List & Label behavior.

     
    Public Event  
    Top
    See Also