Share via


Textbox Class

Represents a text box.

Inheritance Hierarchy

System.Object
  Microsoft.ReportingServices.RdlObjectModel.ReportObjectBase
    Microsoft.ReportingServices.RdlObjectModel.ReportObject
      Microsoft.ReportingServices.RdlObjectModel.ReportElement
        Microsoft.ReportingServices.RdlObjectModel.ReportItem
          Microsoft.ReportingServices.RdlObjectModel.Textbox

Namespace:  Microsoft.ReportingServices.RdlObjectModel
Assembly:  Microsoft.ReportingServices.Designer.Controls (in Microsoft.ReportingServices.Designer.Controls.dll)

Syntax

'Declaration
Public Class Textbox _
    Inherits ReportItem
'Usage
Dim instance As Textbox
public class Textbox : ReportItem
public ref class Textbox : public ReportItem
type Textbox =  
    class 
        inherit ReportItem 
    end
public class Textbox extends ReportItem

The Textbox type exposes the following members.

Constructors

  Name Description
Public method Textbox Creates a new instance of the Textbox class.

Top

Properties

  Name Description
Public property ActionInfo Gets or sets the actions that are associated with the ReportItem. (Inherited from ReportItem.)
Public property AllowInHeaderFooter Gets a value that indicates whether the text box is allowed in header or footer. (Overrides ReportItem.AllowInHeaderFooter.)
Public property Bookmark Gets or sets a bookmark that can be linked to by using a Bookmark action. (Inherited from ReportItem.)
Public property CanGrow Indicates the text box height can increase to accommodate the contents.
Public property CanShrink Indicates whether the text box height can decrease to match the contents.
Public property ComponentMetadata Gets or sets the component metadata. (Inherited from ReportObject.)
Public property ContainedReportItems Infrastructure. Gets or sets the sub-items contained in this report item. (Inherited from ReportItem.)
Public property CustomProperties Gets or sets the custom information to be handed to the report rendering component. (Inherited from ReportItem.)
Public property DataElementName Gets or sets the name to use for the data element/attribute for this report item. (Inherited from ReportItem.)
Public property DataElementOutput Gets or sets a value that indicates whether the item should appear in a data rendering. (Inherited from ReportItem.)
Public property DataElementStyle Indicates whether all TextRun values for this text box should render as an element or attribute.
Public property DefaultName The default text box name.
Public property DocumentMapLabel Gets or sets a label to identify an instance of a report item within the client UI, This provides a user-friendly label for searching. (Inherited from ReportItem.)
Public property DocumentMapLabelLocID Gets or sets the unique identifier for the DocumentMapLabel property. (Inherited from ReportItem.)
Public property Height Gets or sets the height of the item. (Inherited from ReportItem.)
Public property HideDuplicates Indicates the text should not be displayed when the value of the expression associated with the report item is the same as the preceding visible instance.
Public property KeepTogether Gets or sets whether the entire contents of the text box should be kept together on one page if possible.
Public property Left Gets or sets the distance of the item from the left of the containing object. (Inherited from ReportItem.)
Public property Name Gets or sets the name of the report item. (Inherited from ReportItem.)
Public property Paragraphs Gets or sets the collection of Paragraph elements.
Public property Parent The parent of this report object. (Inherited from ReportObjectBase.)
Public property RepeatWith Gets or sets the name of a data region that this report item should be repeated with if that data region spans multiple pages. (Inherited from ReportItem.)
Public property Site Infrastructure. Gets or sets the site associated with the ReportObject object. (Inherited from ReportObject.)
Public property Style Gets the style properties of this report definition object. (Inherited from ReportElement.)
Public property ToggleImage Gets or sets the initial state of a toggling image should one be displayed as a part of the text box.
Public property ToolTip Gets or sets a textual label for the report item. Used for such things as rendering TITLE and ALT attributes in HTML reports. (Inherited from ReportItem.)
Public property ToolTipLocID Gets or sets the unique identifier for the ToolTip property. (Inherited from ReportItem.)
Public property Top Gets or sets the distance of the item from the top of the containing object. (Inherited from ReportItem.)
Public property UserSort Gets or sets the end-user sort control should be displayed as a part of this text box in the UI.
Public property Visibility Gets or sets the current visibility state of this report object. (Inherited from ReportItem.)
Public property WatermarkTextbox Gets or sets the settings for watermark text.
Public property Width Gets or sets the width of the item. Negative sizes allowed only for lines. (Inherited from ReportItem.)
Public property ZIndex Gets or sets the drawing order of the report item within the containing object. (Inherited from ReportItem.)

Top

Methods

  Name Description
Public method DeepClone Returns a deep clone of this ReportObject instance. (Inherited from ReportObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetContainingDataScopes Infrastructure. Returns the list of report object that contains data scopes. (Inherited from ReportObject.)
Protected method GetDataScopesForDefaultImpl Infrastructure. Returns the data scopes for default implementation. (Inherited from ReportObject.)
Protected method GetDependenciesCore Infrastructure. Returns the dependencies core for the ReportObject object. (Inherited from ReportObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Initialize Initializes an instance of the Textbox class. (Overrides ReportItem.Initialize().)
Protected method InitializeForDesigner Infrastructure. Initializes an instance of the Textbox class for the designer. (Overrides ReportItem.InitializeForDesigner().)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnChildPropertyChanged Infrastructure. Raises an event when the property of the child was changed. (Inherited from ReportObject.)
Protected method OnPropertyChanged Infrastructure. Raises an event when the property was changed. (Inherited from ReportObject.)
Protected method RdlSemanticEqualsCore Infrastructure. Returns whether the report definition language semantic is the same with the core object. (Inherited from ReportObject.)
Protected method SavePropertyValue<T> Infrastructure. Saves the property value of the report object. (Inherited from ReportObject.)
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member AllowTypeInHeaderFooter Specifies whether the text box allows type in header or footer.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose Infrastructure. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ReportObject.)
Explicit interface implemetationPrivate event IComponent.Disposed Infrastructure. Occurs when the ReportObject object is disposed. (Inherited from ReportObject.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.ReportingServices.RdlObjectModel Namespace