BarCodeControl Class |
Control to render bar codes.
Inheritance Hierarchy
System
Object
System.Web.UI Control
System.Web.UI.WebControls WebControl
Spire.Barcode.WebUI BarCodeControl
System.Web.UI Control
System.Web.UI.WebControls WebControl
Spire.Barcode.WebUI BarCodeControl
Namespace: Spire.Barcode.WebUI
Assembly: Spire.Barcode (in Spire.Barcode.dll) Version: 7.3.7.0 (7.3.7.9046)
Syntax
The BarCodeControl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
BarCodeControl |
Creates a new instance of the
BarCodeControl
class.
|
Properties
| Name | Description | |
|---|---|---|
|
AccessKey |
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from
WebControl
.)
|
|
Adapter |
Gets the browser-specific adapter for the control.
(Inherited from
Control
.)
|
|
|
AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the
Page
or
UserControl
object that contains this control.
(Inherited from
Control
.)
|
|
|
Attributes |
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from
WebControl
.)
|
|
|
AutoResize |
The size of image automatically.
|
|
|
AztecErrorCorrection |
Gets or sets a value specifies what degree of error correction. the default is 23.
|
|
|
AztecLayers |
Gets or sets a value specifies the required number of layers for an Aztec code.
A negative number(-1, -2, -3, -4) specifies a compact Aztec code
0 indicates to use the minimum nuber for layers (the default)
A positive number (1, 2, ... 32) specifies a normal (non-compact) Aztec code.
|
|
|
BackColor |
The back color of the barcode.
|
|
|
BarCodeHandlerUrl |
Barcode HTTP handler URL.
|
|
|
BarHeight |
The height of the bar.
|
|
|
BorderColor |
Border's color.
|
|
|
BorderDashStyle |
Border's Dash style.
|
|
|
BorderStyle |
Gets or sets the border style of the Web server control.
(Inherited from
WebControl
.)
|
|
|
BorderWidth |
Borders's width of barcode image.
|
|
|
BottomMargin |
The bottom margin of the barcode.
|
|
|
BottomText |
Text bottom barcode.
|
|
|
BottomTextAligment | |
|
|
BottomTextColor |
Text bottom barcode style.
|
|
|
BottomTextFont |
Text bottom barcode style.
|
|
|
ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from
Control
.)
|
|
|
ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET.
(Inherited from
Control
.)
|
|
|
ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the
ClientID
property.
(Inherited from
Control
.)
|
|
|
ClientIDSeparator |
Gets a character value representing the separator character used in the
ClientID
property.
(Inherited from
Control
.)
|
|
|
CodabarStartChar |
Start character of codabar barcode.
|
|
|
CodabarStopChar |
Stop character of codabar barcode.
|
|
|
Code128SetMode | |
|
|
ColumnCount |
Columns of 2D Barcode.
|
|
|
Context |
Gets the
HttpContext
object associated with the server control for the current Web request.
(Inherited from
Control
.)
|
|
|
Controls |
Gets a
ControlCollection
object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from
Control
.)
|
|
|
ControlStyle |
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
ControlStyleCreated |
Gets a value indicating whether a
Style
object has been created for the
ControlStyle
property. This property is primarily used by control developers.
(Inherited from
WebControl
.)
|
|
|
CssClass |
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from
WebControl
.)
|
|
|
Data |
The data to render with the barcode.
|
|
|
Data2D |
The data to render with the 2D barcode.
|
|
|
DataMatrixSymbolShape |
Gets or sets a value specifies the symbol shape hint for DataMatrix barcode. the default is Auto.
|
|
|
DesignMode |
Gets a value indicating whether a control is being used on a design surface.
(Inherited from
Control
.)
|
|
|
DpiX |
Gets or sets the horizontal resolution.
|
|
|
DpiY |
Gets or sets the horizontal resolution.
|
|
|
Enabled |
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from
WebControl
.)
|
|
|
EnableTheming |
Gets or sets a value indicating whether themes apply to this control.
(Inherited from
WebControl
.)
|
|
|
EnableViewState |
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from
Control
.)
|
|
|
Events |
Gets a list of event handler delegates for the control. This property is read-only.
(Inherited from
Control
.)
|
|
|
Font |
Gets the font properties associated with the Web server control.
(Inherited from
WebControl
.)
|
|
|
FontColor |
The font color of the barcode.
|
|
|
ForeColor |
The fore color of the barcode.
|
|
|
HasAttributes |
Gets a value indicating whether the control has attributes set.
(Inherited from
WebControl
.)
|
|
|
HasBorder |
Indicates whether has border;
|
|
|
HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from
Control
.)
|
|
|
Height |
Gets or sets the height of the Web server control.
(Inherited from
WebControl
.)
|
|
|
ID |
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from
Control
.)
|
|
|
IdSeparator |
Gets the character used to separate control identifiers.
(Inherited from
Control
.)
|
|
|
ImageFormat |
Gets and sets the format of the rendered barcode image
|
|
|
ImageHeight |
Height of Barcode image.
|
|
|
ImageWidth |
Width of Barcode image.
|
|
|
IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state.
(Inherited from
Control
.)
|
|
|
IsEnabled |
Gets a value indicating whether the control is enabled.
(Inherited from
WebControl
.)
|
|
|
IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from
Control
.)
|
|
|
IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control.
(Inherited from
Control
.)
|
|
|
ITF14BearerBars |
ITF14 Barcode's bearer bars
|
|
|
LeftMargin |
The width offset of the barcode.
|
|
|
LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by
ID
instead of index.
(Inherited from
Control
.)
|
|
|
MacroFileIndex |
Gets or sets macro pdf417 Barcode's file index.
|
|
|
MacroSegmentIndex |
Gets or sets macro pdf417 Barcode's segment index.
|
|
|
NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same
ID
property value.
(Inherited from
Control
.)
|
|
|
Page |
Gets a reference to the
Page
instance that contains the server control.
(Inherited from
Control
.)
|
|
|
Parent |
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from
Control
.)
|
|
|
Pdf417DataMode |
Gets or sets data mode of Pdf417 barcode.
|
|
|
Pdf417ECL |
Error correction level of pdf417 Barcode.
|
|
|
Pdf417Truncated |
Indicates wheter has been truncated of pdf 417 Barcode.
|
|
|
QRCodeDataMode |
Gets or sets of QRCode Barcode.
|
|
|
QRCodeECL |
Error correction level of QRCode Barcode.
|
|
|
QRCodeLogoImage |
Gets or sets logo image of QRCode Barcode.
|
|
|
RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.
(Inherited from
Control
.)
|
|
|
ResolutionType |
Gets or sets the resolution.
|
|
|
RightMargin |
The right margin of the barcode.
|
|
|
Rotate |
Rotation angle of Barcode image.
|
|
|
RowCount |
Rows of 2D Barcode.
|
|
|
ShowBottomText |
Indicates whether shows bottom text.
|
|
|
ShowCheckSumChar |
Indicates whether shows checksum digit in Code128 and EAN128 Barcodes.
|
|
|
ShowStartCharAndStopChar |
Show start character and stop character of codabar barcode.
|
|
|
ShowText |
Indicates whether display barcode data text.
|
|
|
ShowTextOnBottom |
Indicates whether display barcode data text on bottom.
|
|
|
ShowTopText |
Indicates whether shows top text.
|
|
|
Site |
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from
Control
.)
|
|
|
SkinID |
Gets or sets the skin to apply to the control.
(Inherited from
WebControl
.)
|
|
|
Style |
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from
WebControl
.)
|
|
|
SupData |
Supplement data.
|
|
|
SupportsDisabledAttribute |
Gets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to "disabled" when the control's
IsEnabled
property is false.
(Inherited from
WebControl
.)
|
|
|
SupSpace |
Space between main and supplement Barcode.
|
|
|
TabIndex |
Gets or sets the tab index of the Web server control.
(Inherited from
WebControl
.)
|
|
|
TagKey |
Gets the
HtmlTextWriterTag
value that corresponds to this Web server control. This property is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
TagName |
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
TemplateControl |
Gets or sets a reference to the template that contains this control.
(Inherited from
Control
.)
|
|
|
TemplateSourceDirectory |
Gets the virtual directory of the
Page
or
UserControl
that contains the current server control.
(Inherited from
Control
.)
|
|
|
TextAlignment |
The position of the text.
|
|
|
TextColor |
The color of the text of the barcode.
|
|
|
TextFont |
The font of the barcode text.
|
|
|
TextMargin |
Space between barcode and text.
|
|
|
TextRenderingHint |
Quality of text rendering.
|
|
|
ToolTip |
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from
WebControl
.)
|
|
|
TopMargin |
The top margin of the barcode.
|
|
|
TopText |
Text above barcode.
|
|
|
TopTextAligment | |
|
|
TopTextColor |
Text above barcode style.
|
|
|
TopTextFont |
Text above barcode style.
|
|
|
TopTextMargin | |
|
|
Type |
The type of the barcode to render.
|
|
|
UniqueID |
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from
Control
.)
|
|
|
Unit |
The unit to use when rendering the barcode.
|
|
|
UseAntiAlias |
Inidcates whether use anti alias mode to render image.
|
|
|
UseChecksum |
Indicates whether to use a checksum on barcodes where it is optional.
|
|
|
UseHttpHandlerMode |
Indicates whether use httphandler mode to render barcode.
<system.web><httpHandlers><add verb="*" path="BarCodeHandler.axd" type="Spire.Barcode.WebUI.BarCodeHandler,Spire.Barcode" /></httpHandlers></system.web> |
|
|
ValidateRequestMode |
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.
(Inherited from
Control
.)
|
|
|
ViewState |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from
Control
.)
|
|
|
ViewStateIgnoresCase |
Gets a value that indicates whether the
StateBag
object is case-insensitive.
(Inherited from
Control
.)
|
|
|
ViewStateMode |
Gets or sets the view-state mode of this control.
(Inherited from
Control
.)
|
|
|
Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from
Control
.)
|
|
|
WideNarrowRatio |
Wide/narrow ratio.
|
|
|
Width |
Gets or sets the width of the Web server control.
(Inherited from
WebControl
.)
|
|
|
X |
Width of barcode bar module.
|
|
|
XYRatio |
Height/width ratio of 2D Barcode's module.
|
|
|
Y |
Height of 2D barcode bar module.
|
Methods
| Name | Description | |
|---|---|---|
|
AddAttributesToRender |
Adds HTML attributes and styles that need to be rendered to the specified
HtmlTextWriterTag
. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
AddedControl |
Called after a child control is added to the
Controls
collection of the
Control
object.
(Inherited from
Control
.)
|
|
|
AddParsedSubObject |
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's
ControlCollection
object.
(Inherited from
Control
.)
|
|
|
ApplyStyle |
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from
WebControl
.)
|
|
|
ApplyStyleSheetSkin |
Applies the style properties defined in the page style sheet to the control.
(Inherited from
Control
.)
|
|
|
BuildProfileTree |
Gathers information about the server control and delivers it to the
Trace
property to be displayed when tracing is enabled for the page.
(Inherited from
Control
.)
|
|
|
ClearCachedClientID |
Sets the cached
ClientID
value to null.
(Inherited from
Control
.)
|
|
|
ClearChildControlState |
Deletes the control-state information for the server control's child controls.
(Inherited from
Control
.)
|
|
|
ClearChildState |
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from
Control
.)
|
|
|
ClearChildViewState |
Deletes the view-state information for all the server control's child controls.
(Inherited from
Control
.)
|
|
|
ClearEffectiveClientIDMode |
Sets the
ClientIDMode
property of the current control instance and of any child controls to
Inherit
.
(Inherited from
Control
.)
|
|
|
CopyBaseAttributes |
Copies the properties not encapsulated by the
Style
object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
CreateChildControls |
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
(Inherited from
Control
.)
|
|
|
CreateControlCollection |
Creates a new
ControlCollection
object to hold the child controls (both literal and server) of the server control.
(Inherited from
Control
.)
|
|
|
CreateControlStyle |
Creates the style object that is used internally by the
WebControl
class to implement all style related properties. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
DataBind |
Binds a data source to the invoked server control and all its child controls.
(Inherited from
Control
.)
|
|
|
DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the
DataBinding
event.
(Inherited from
Control
.)
|
|
|
DataBindChildren |
Binds a data source to the server control's child controls.
(Inherited from
Control
.)
|
|
|
Dispose |
Enables a server control to perform final clean up before it is released from memory.
(Inherited from
Control
.)
|
|
|
EnsureChildControls |
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from
Control
.)
|
|
|
EnsureID |
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from
Control
.)
|
|
|
Equals |
Determines whether the specified object is equal to the current object.
(Inherited from
Object
.)
|
|
|
Finalize |
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from
Object
.)
|
|
|
FindControl(String) |
Searches the current naming container for a server control with the specified
id
parameter.
(Inherited from
Control
.)
|
|
|
FindControl(String, Int32) |
Searches the current naming container for a server control with the specified
id
and an integer, specified in the
pathOffset
parameter, which aids in the search. You should not override this version of the
FindControl
method.
(Inherited from
Control
.)
|
|
|
Focus |
Sets input focus to a control.
(Inherited from
Control
.)
|
|
|
GenerateImage |
Generate barcode image.
|
|
|
GetDesignModeState |
Gets design-time data for a control.
(Inherited from
Control
.)
|
|
|
GetHashCode |
Serves as the default hash function.
(Inherited from
Object
.)
|
|
|
GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters.
(Inherited from
Control
.)
|
|
|
GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters.
(Inherited from
Control
.)
|
|
|
GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from
Control
.)
|
|
|
GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from
Control
.)
|
|
|
GetType |
Gets the
Type
of the current instance.
(Inherited from
Object
.)
|
|
|
GetUniqueIDRelativeTo |
Returns the prefixed portion of the
UniqueID
property of the specified control.
(Inherited from
Control
.)
|
|
|
HasControls |
Determines if the server control contains any child controls.
(Inherited from
Control
.)
|
|
|
HasEvents |
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from
Control
.)
|
|
|
IsLiteralContent |
Determines if the server control holds only literal content.
(Inherited from
Control
.)
|
|
|
LoadControlState |
Restores control-state information from a previous page request that was saved by the
SaveControlState
method.
(Inherited from
Control
.)
|
|
|
LoadViewState |
Restores view-state information from a previous request that was saved with the
SaveViewState
method.
(Inherited from
WebControl
.)
|
|
|
MapPathSecure |
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from
Control
.)
|
|
|
MemberwiseClone |
Creates a shallow copy of the current
Object
.
(Inherited from
Object
.)
|
|
|
MergeStyle |
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
OnBubbleEvent |
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from
Control
.)
|
|
|
OnDataBinding |
Raises the
DataBinding
event.
(Inherited from
Control
.)
|
|
|
OnInit |
init function
(Overrides
Control
OnInit(EventArgs)
.)
|
|
|
OnLoad |
Raises the
Load
event.
(Inherited from
Control
.)
|
|
|
OnPreRender |
Raises the
PreRender
event.
(Inherited from
Control
.)
|
|
|
OnUnload |
Raises the
Unload
event.
(Inherited from
Control
.)
|
|
|
OpenFile |
Gets a
Stream
used to read a file.
(Inherited from
Control
.)
|
|
|
RaiseBubbleEvent |
Assigns any sources of the event and its information to the control's parent.
(Inherited from
Control
.)
|
|
|
RemovedControl |
Called after a child control is removed from the
Controls
collection of the
Control
object.
(Inherited from
Control
.)
|
|
|
Render |
Render this control to the output parameter specified.
(Overrides
WebControl
Render(HtmlTextWriter)
.)
|
|
|
RenderBeginTag |
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
RenderChildren |
Outputs the content of a server control's children to a provided
HtmlTextWriter
object, which writes the content to be rendered on the client.
(Inherited from
Control
.)
|
|
|
RenderContents |
Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
RenderControl(HtmlTextWriter) |
Outputs server control content to a provided
HtmlTextWriter
object and stores tracing information about the control if tracing is enabled.
(Inherited from
Control
.)
|
|
|
RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided
HtmlTextWriter
object using a provided
ControlAdapter
object.
(Inherited from
Control
.)
|
|
|
RenderEndTag |
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from
WebControl
.)
|
|
|
ResolveAdapter |
Gets the control adapter responsible for rendering the specified control.
(Inherited from
Control
.)
|
|
|
ResolveClientUrl |
Gets a URL that can be used by the browser.
(Inherited from
Control
.)
|
|
|
ResolveUrl |
Converts a URL into one that is usable on the requesting client.
(Inherited from
Control
.)
|
|
|
SaveControlState |
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from
Control
.)
|
|
|
SaveToFile(String) |
Save image to disk file.
|
|
|
SaveToFile(String, ImageFormat) |
Save image to disk file.
|
|
|
SaveToStream |
Save image to stream.
|
|
|
SaveViewState |
Saves any state that was modified after the
TrackViewState
method was invoked.
(Inherited from
WebControl
.)
|
|
|
SetDesignModeState |
Sets design-time data for a control.
(Inherited from
Control
.)
|
|
|
SetRenderMethodDelegate |
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from
Control
.)
|
|
|
ToString |
Returns a string that represents the current object.
(Inherited from
Object
.)
|
|
|
TrackViewState |
Causes the control to track changes to its view state so they can be stored in the object's
ViewState
property.
(Inherited from
WebControl
.)
|
Events
| Name | Description | |
|---|---|---|
|
DataBinding |
Occurs when the server control binds to a data source.
(Inherited from
Control
.)
|
|
|
Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from
Control
.)
|
|
|
Init |
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from
Control
.)
|
|
|
Load |
Occurs when the server control is loaded into the
Page
object.
(Inherited from
Control
.)
|
|
|
PreRender |
Occurs after the
Control
object is loaded but prior to rendering.
(Inherited from
Control
.)
|
|
|
Unload |
Occurs when the server control is unloaded from memory.
(Inherited from
Control
.)
|
See Also
