combit List & Label 26 - .NET Help
Inheritance Hierarchy
In This Topic
    combit.Reporting Namespace
    In This Topic
    The main component which holds all important List & Label base functions for print and design. Comfortable class wrappers are available. Advice for their usage can be found in this help.
    Classes
     ClassDescription
    Class

    Eventarguments for the delegate AutoDefineDataItemHandler

    Class

    Eventarguments for the delegates:

    AutoDefineField

    AutoDefineVariable

    Class

    Eventarguments for the delegates:

    AutoDefineNewLine

    Class

    Eventarguments for the delegates:

    AutoDefineNewPage

    Class 
    ClassRepresents a chart field.
    ClassCollection of all chart fields.
    ClassEnumerator for the chart fields.
    Class

    Eventarguments for the delegates:

    CheckFunctionSyntax

    ClassHelper class to convert certain units.
    Class

    Eventarguments for the delegates:

    CreateDesignerObject

    Class 
    Class 
    Class

    Extends the Designer's menu and optionally the toolbar of the Designer.

    ClassCollection of all Designer actions.
    ClassControl class that allows to place the Designer onto existing Windows Form instances.
    Class

    One of the important and powerful options of the designer is the formula assistant and the functions offered in it. With the help of the DesignerFunction and the component's Evaluate event, a function that can be handled separately by the program is offered to the user.

    Class

    Collection of all designer functions.

    Class

    Represents a parameter for a designer function.

    Class

    The available design languages in the Designer can be defined hereby.

    The language for the report can be switched in the Designer later to be able to create localized versions of the report.

    For further information about localization of reports see Localization of Project Files in Designer.

    Class

    Similar to the enhancement of the designer functions, you can also define custom object types and register them with List & Label. The new objects are subsequently available to the user in the usual manner through the toolbar on the left and the menu.

    Here, a special Collection Editor is also available. You can access it in the development environment with the "..." button of the property DesignerObjects of the previously placed List & Label .NET component. With the "Add" button, you can add a new object type.

    See also the provided programmable samples "C# Designer Extension Sample" / "VB.NET Designer Extension Sample".

    Class

    Collection of all designer objects.

    Class 
    Class

    Access to the designer window.

    Class

    Eventarguments for the delegates:

    DrawDesignerObject

    Class

    Eventarguments for the delegates:

    DrawObject

    Class

    Eventarguments for the delegates:

    DrawPage

    Class

    Eventarguments for the delegates:

    DrawProject

    Class

    Eventarguments for the delegates:

    DrawTableField

    Class

    Eventarguments for the delegates:

    DrawTableLine

    Class

    Eventarguments for the delegates:

    EditDesignerObject

    ClassRepresents a Field, a Variable or a ChartField.
    Class

    Base class for element collections (Fields, Variables, ChartFields).

    Class

    Eventarguments for the delegates:

    Evaluate

    Class

    Eventarguments for the delegates:

    EvaluateFunction

    ClassThis class is used as parameter for the Export Method. It contains the configuration parameters for the export like target file and format.
    Class 
    Class

    Eventarguments for the delegates:

    ExpressionError

    Class

    List & Label offers an extensive formula parser, which can also easily be used in customized applications. This way you can offer your customer an efficient tool for customization. The class ExpressionEvaluator offers the parser. Here, the usual options of the VariableCollection are at your disposal. If you want to carry out evaluation on the basis of an existing instance of the ListLabel component, simply use the EvaluateExpression method. Through a Boolean parameter, you can indicate whether only the registered variables are to be evaluated or the fields as well.

    Class 
    Class

    Represents a Field, i.e. a content block for a table.

    Class

    Collection of available fields.

    Class

    Enumerator for the available fields.

    ClassFile extensions for the respective project types can be queried or edited with this class.
    Class

    Contains detailed information on the available syntax hints, autocomplete entries etc. for a designer function.

    Class

    Eventargument for the event:

     GetActionState

    ClassThis event is used to query the DesignerObject Class for height information in order to wrap the object ideally.
    Class 
    Class 
    Class

    This class represents an instance of the List & Label object. You can set many options via the properties. The methods allow for a quick design and print access. The events give you further capabilities to influence the print result. The collections for designer objects and functions enable you to add functions and objects to the designer.

    The Core object gives you access to the full List & Label API. Last but not least the collections for fields, variables and chart fields host the data that make up the building blocks of your design. Add different types of data and choose the placeholder names for your end users.

    ClassWith this class you can control the behavior of the Designer, mask functions out, set the window title etc.
    Class

    The ListLabelDocument class is a descendant of PrintDocument. It enables the usage of List & Label preview files for standard preview controls.

    ClassBase class for all List & Label exceptions.
    ClassThis class allows to set the options for the export modules in databinding mode. An export without user interaction for example can be realized with it.
    ClassThis class represents the toolbar buttons of the List & Label preview control. It enables you to set and query the state of the buttons.
    ClassThe preview control displays List & Label preview files. The control also allows export to other formats like PDF or Multi-TIFF.
    Class

    Eventarguments for the delegates:

    ButtonPress

    ClassThis event tells you when the preview file is completely loaded. Furthermore the parameter isSuccessful tells you if the loading process was successful.
    Class

    Eventarguments for the delegates:

    PageChanged

    Class

    Defines styles for selected and non selected pages.

    Class

    Defines frames for selected and non selected pages.

    Class

    Defines how the pages in the preview control become zoomed.

    ClassThis class allows you to use the List & Label RTF editor directly within your forms. The content can be rendered to any given device context.
    Class 
    ClassThis class represents a barcode that can be used as variable or field.
    Class

    The Core class gives you access to the full API of List & Label. Usually these APIs are only needed when not working in databound mode.

    Class 
    Class 
    Class 
    Class

    This class allows to send emails.

    Class 
    Class

    Event arguments for event NextCombinationPrintStep.

    Class 
    Class 
    ClassWith this event you can enquire the printing progress to preview.
    Class 
    Class

    Eventarguments for the delegates:

    ParameterAutoComplete

    Class 
    Class

    The List & Label Storage API provides access to the LL preview files. You can query general information from individual pages, place multiple files together, and store user data. In the case of .NET components, the API options are accessed with the two classes PreviewFile and PreviewPage. Each of them represents a complete preview file or an individual page of a file.

    Class

    This class represents a page of the preview file.

    Class

    Eventarguments for the delegates:

    PrintJobInfo

    Class 
    Class 
    ClassA project specific parameter that can be defined by ProjectParameters.
    ClassAdd or query project parameters here.
    Class 
    Class 
    Class 
    Class 
    Class

    Eventarguments for the delegates:

    SaveFilename

    Class 
    Class

    Eventarguments for the delegates:

    ShowHelp

    Class 
    Class 
    Class 
    ClassRepresents a variable, i.e. a data content e.g. for a text object.
    ClassCollection of available variables.
    Class

    Eventarguments for the delegates:

    VariableHelpText

    Class

    EventArgs for the ViewerActionResult event.

    Class

    Eventarguments for the delegates:

    ViewerButtonClicked

    Class

    Eventarguments for the delegates:

    ViewerButtonState

    Class 
    ClassThis class provides properties which represent the viewer window.
    Interfaces
    Structures
     StructureDescription
    StructureEnumeration of important constants.
    Structure 
    Structure 
    Structure 
    Structure 
    Structure 
    Structure 
    Delegates
     DelegateDescription
    Delegate

    Enables the application to influence the tables, table relations and sort orders passed by the databinding engine.

    Delegate

    Enables the application to influence fields and variables passed by the databinding engine.

    Delegate

    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.

    Delegate

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

    Delegate

    You can check the syntax with CheckFunctionSyntax. Here, you can check the data type of parameters and make sure that the parameters are, for instance, placed in a specific range.

    Delegate

    The event CreateDesignerObject is triggered when the user creates a new object. If desired, you can show the initial dialog to the user. This can, for instance, be an assistant that makes it simple for the user to configure the new object. If you don't want to offer this, simply forego processing of the event. The following example shows the display of a MessageBox as soon as the new object is placed in the workspace for the first time. You gain access to the designer window through the event argument. The passed class supports the IWin32Window interface and can, as a result, be used for a MessageBox or another window as a parent.

    Delegate 
    Delegate

    This event is triggered by the print and design methods for transferring data to List & Label if no DataSource has been assigned. The event arguments are always of the DefineElementsEventArgs type.

    Delegate

    Legacy event, use ExportOptions Property instead.

    Delegate

    This event is triggered by the print and design methods for transferring data to List & Label if no DataSource has been assigned. The event arguments are always of the DefineElementsEventArgs type.

    DelegateIs called when the user triggered an action.
    DelegateIs called when the toolbar is refreshed. With this event you can define the state of the action.
    Delegate

    After the user has edited the object, you are asked by List & Label to draw the object. The event DrawDesignerObject is triggered for this purpose. A Graphics object and the rectangle of the object are passed through EventArguments. Now, you can draw in the work area with the known GDI + methods. While doing so, access to the underlying object properties is naturally possible and useful. The sample listing shows the presentation of the graphic file selected above.

    Delegate

    The event DrawObject is called for every object displayed by List & Label. The event arguments provide a graphic object as well as the area of the object. In this area, you can for example hide or draw the object.

    Delegate

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

    Delegate

    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.

    Delegate

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

    Delegate

    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).

    Delegate

    This event is triggered, when the user double clicks on the newly added object or selects the item "Properties" from the context menu. Here as well, you can gain access to the designer window through event arguments, and a separate dialog can be displayed. In the example, you see the display of a file selection dialog. Here, you can choose a graphic to be displayed in the designer. The dialog is displayed by double-clicking on the object.

    Delegate

    The event EvaluateFunction has to be handled in order to activate the function. You can gain access to the parameters indicated by the user through event arguments. Use the following lines in order to return the total of both parameters, for instance.

    DelegateLegacy event. Use DesignerFunction Class instead.
    Delegate

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

    Delegate

    This event informs that the last data record declared was not displayed as it did not meet a given filter condition. Additional event arguments are not offered.

    Delegate 
    Delegate

    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.

    DelegateThis event tells you when the preview file is completely loaded. Furthermore the parameter isSuccessful tells you if the loading process was successful.
    Delegate

    Tells you that the current page has been changed.

    Delegate 
    DelegateWith this event you can enquire the printing progress to preview.
    Delegate

    Via ParameterAutoComplete, it is possible to give different recommended values to the AutoComplete feature of the formula assistant.

    Delegate 
    Delegate

    This event is called every time the state of the print job has changed in the spooler.

    Delegate 
    DelegateThis event is called when a project will be loaded in the Designer.
    Delegate 
    Delegate

    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.

    Delegate 
    Delegate

    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.

    Delegate

    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.

    Delegate

    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.

    Delegate

    This event allows you to manipulate the preview window. The event is called for each element of the toolbar. The event arguments allow access to the respective IDs. With the return status, you can determine whether or not the user can use the element.

    Enumerations
     EnumerationDescription
    EnumerationDefines the unit.
    Enumeration

    Different available data binding modes.

    EnumerationDefines if the menu item is inserted before or after the entry defined in MenuHierachy.
    Enumeration

    Enumeration for the possible values for property DropShadowType to define the drop shadow behaviour of a page.

    Enumeration

    Enumeration of the possible values for property SelectionFrame to define the frame type of each selected page.

    EnumerationSets the state of the menu entry or the button in the toolbar.
    Enumeration

    The data transfer type is determined with the help of the property AutoMasterMode. The underlying enumeration provides the following values:

    Enumeration 
    Enumeration

    Changes the text display mode for barcodes.

    EnumerationEnumeration of supported barcodes.
    EnumerationChanges the progress dialog type.
    EnumerationChanges the button state.
    EnumerationEnumeration of special character representation codes.
    Enumeration

    With this enumeration the chart type can be defined. Every value of this enumeration represents one chart.

    Enumeration

    Changes dialog style adaption options.

    EnumerationEnumeration of various debug flags.
    EnumerationChanges the type of chart object that receives the current chart declaration.
    EnumerationEnumeration of all possible menu items and buttons of the toolbar.
    Enumeration

    When opening a project you must choose whether the file should be opened if existing, created always etc. This can be specified by using one of the enumeration values.

    Enumeration

    Defines if the currently opened project is saved when another project is loaded.

    Enumeration

    Changes the print target.

    EnumerationEnumeration of various text styles.
    EnumerationEnumeration of various button styles.
    EnumerationEnumeration of various frame styles.
    EnumerationEnumeration of various dialog styles.
    EnumerationDefines the type of the Dictionary.
    Enumeration

    Enumeration of error codes. These are mapped to exceptions for this assembly.

    EnumerationEnumeration of available export options.
    EnumerationCollection of the available export targets.
    Enumeration 
    EnumerationEnumeration of expression types.
    EnumerationEnumeration of various extension types.
    EnumerationEnumeration of supported field types.
    EnumerationEnumeration of the file types belonging to a project type. For further information see the FileExtensions Class.
    EnumerationReturns the number of chart objects.
    Enumeration

    Enables the programmer to use an external help system instead of List & Label's own help system.

    Enumeration 
    EnumerationDefines the type of the structure element.
    Enumeration

    Enumeration of the different user interface languages. You might have to purchase one of the optionally available language kits in order to set the language of your choice.

    EnumerationEnumeration of supported coordinate systems.
    EnumerationEnumeration of the different formula modes.
    EnumerationEnumeration of object types.
    EnumerationEnumeration of various options.
    EnumerationEnumeration of various option strings.
    EnumerationEnumeration of paper orientations.
    EnumerationEnumeration of parameter types.
    EnumerationChanges the behavior of the preview control when closing.
    EnumerationEnumeration of various printer commands.
    EnumerationChanges the behavior of LlPrintCopyPrinterConfiguration Method.
    EnumerationChanges the printer to be set.
    Enumeration

    Enumeration of output formats.

    EnumerationEnumeration of various print options.
    EnumerationEnumeration of various print option strings.
    EnumerationEnumeration of possible printing orders for label printing.
    EnumerationEnumeration of project types.
    EnumerationEnumeration of all predefined project parameters which can be set as the default in the Designer. Further information can be found in the ProjectParameters Class.
    EnumerationEnumeration of all project parameter categories. For further information see the Category Property.
    Enumeration

    Different flags that determine the type of project parameter.

    EnumerationEnumeration of project parameter scopes. For further information see Scope Property.
    EnumerationEnumeration of all possible types for project parameters. For further information see the ParameterType Property.
    EnumerationEnumeration of the visibility of project parameters. For further information see the Visibility Property.
    Enumeration

    Options for the content evaluation.

    EnumerationEnumeration of all menu items and buttons for the toolbar of the RTF-Editor.
    EnumerationVarious print states of the RTF Control.
    Enumeration

    Options for the format of the text to be retrieved.

    EnumerationContains constants to control the behavior of LlSetPrinterInPrinterFile.
    EnumerationEnumeration of various preview file options.
    Enumeration

    Options for printing preview files.

    EnumerationSets the file mode for preview files.
    EnumerationChanges the table coloring mode for list projects.
    Enumeration

    Enumeration of the cell types of a table.

    Enumeration

    Enumeration of the line types of a table.

    EnumerationEnumeration of the table options.
    EnumerationVarious tab modes.
    Enumeration 
    Enumeration 
    EnumerationEnumeration of various dialog styles.
    EnumerationVarious units.
    EnumerationList & Label version number.
    EnumerationEnumeration of all menu items and buttons for the toolbar of the List & Label Viewer.
    Enumeration

    Button state of the viewer control.

    Enumeration 
    EnumerationDifferent modes for the zoom value to be used can be selected here.
    EnumerationContains predefined values for the preview zoom.
    Enumeration 
    Enumeration 
    EnumerationVarious flags for the function LsMailConfigurationDialog.
    Enumeration 
    Enumeration 
    Enumeration

    Decides how to proceed after the ReportParametersCollected event was raised.

    Enumeration 
    Enumeration 
    Enumeration

    Contains the type of Text for preprocessing by the event ProcessText.

    See Also