DNN Community Blog

Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact community@dnnsoftware.com.

 


Using the DNN Text Suggest Control

The DNNTextSuggest control is actually a very complex control. You can go to the example website at: http://webcontrols.dotnetnuke.com where you can test out all the DNN web controls (you can download the source here). The control allows you to type in text and provides matching items from a data source (for example a database). This provides the same  functionality as Google Suggests.

This is an amazingly complex control and you are advised to read the extensive documentation that is provided to fully explore it's features. This is a brief introduction to the control to show how easy it is to get it up and running.

Here are the steps to implement this web control in your own modules. This works with the full version of Visual Studio 2005 and also Visual Web Developer Express.

If you haven't already performed this step, you will want to add the DNN web controls to your Visual Studio toolbox:

  1. Right-Click on the Toolbox in Visual Studio and select Choose Items...

     
  2. Use the Browse button to browse to DotNetNuke.WebControls.dll (in the /bin folder of your DotNetNuke installation) and click the OK button.
  3. The DotNetNuke web controls will now appear in your toolbox:

     
  4. Drag the DNNTextSuggest control from the toolbox and drop it on to your DotNetNuke User Control (See my tutorial Creating a  Super-Simple DotNetNuke module for information on how to create a DotNetNuke Web User Control) .
  1. In the properties for the DNNTextSuggest control, click on the yellow lazerbolt to show the events for the control
  2. We see that there are events that we can wireup a method to. Type "MyDNNTextSuggest_PopulateOnDemand" for the PopulateOnDemand event and click away from the box.
  3. Visual Studio switches to code view and your method is all ready for your custom code. Add "PopulateList(e.Nodes, e.Text)" to the method so it appears like this:

    Protected Sub MyDNNTextSuggest_PopulateOnDemand(ByVal source As Object, ByVal e As DotNetNuke.UI.WebControls.DNNTextSuggestEventArgs) Handles MyDNNTextSuggest.PopulateOnDemand
        PopulateList(e.Nodes, e.Text)
    End Sub

     

  4. Ensure that your User Control has this line toward the top:  Inherits Entities.Modules.PortalModuleBase
  5. Enter this additional code:
     

    Private Sub PopulateList(ByVal objNodes As DNNNodeCollection, ByVal strText As String)

    Dim
    o As DNNNode
    Dim dt As DataTable = GetData()
    'strip out troublesome chars for Select below
    strText = strText.Replace("[", "").Replace("]", "").Replace("'", "''")
    dt.CaseSensitive = Me.MyDNNTextSuggest.CaseSensitive
    Dim drs() As DataRow = dt.Select("name like '" & strText & "%'")
    Dim dr As DataRow
    For Each dr In drs
    If Me.MyDNNTextSuggest.MaxSuggestRows = 0 _
    OrElse objNodes.Count < (Me.MyDNNTextSuggest.MaxSuggestRows + 1) Then
    o = New DNNNode(CStr(dr("name")))
    o.ID = CStr(dr("id"))
    objNodes.Add(o)
    End If
    Next

    End
    Sub

    Private
    Function GetData() As DataTable

    Dim dt As DataTable = New DataTable
    dt.Columns.Add(New DataColumn("id", GetType(String)))
    dt.Columns.Add(New DataColumn("name", GetType(String)))
    AddRow(1, "name1", dt)
    AddRow(2, "name12", dt)
    AddRow(3, "name123", dt)
    AddRow(4, "name1234", dt)
    AddRow(5, "name12345", dt)
    Return dt

    End Function


    Private
    Sub AddRow(ByVal ID As Integer, ByVal Name As String, ByVal dt As DataTable)
    Dim dr As DataRow = dt.NewRow()
    dr("id") = ID
    dr("name") = Name
    dt.Rows.Add(dr)

    End Sub

     
  6. Save the page and Build the page. When you type "name" in the text box it will show you matching items.
  7. You can download the code here.

This example is so simple it really does not do the control justice. However, you can see that the control is just as easy to use as a Microsoft Atlas control. In addition, all of the web controls work with ASP.NET 1.1 and DotNetNuke 3.

Jon Henning continuously develops web controls and provides excellent documentation on the DotNetNuke site. I hope to introduce you to this incredible resource and demonstrate yet another reason why web development is faster and easier when you use the DotNetNuke Framework.

Comments

Comment Form

Only registered users may post comments.

NewsArchives


August 2014 (23)
July 2014 (17)
June 2014 (10)
May 2014 (6)
April 2014 (9)
March 2014 (3)
February 2014 (4)
January 2014 (8)
December 2013 (5)
November 2013 (2)
October 2013 (9)
September 2013 (10)
August 2013 (8)
July 2013 (4)
June 2013 (8)
May 2013 (13)
April 2013 (2)
March 2013 (7)
February 2013 (7)
January 2013 (10)
December 2012 (6)
November 2012 (20)
October 2012 (12)
September 2012 (27)
August 2012 (29)
July 2012 (22)
June 2012 (17)
May 2012 (23)
April 2012 (24)
March 2012 (27)
February 2012 (21)
January 2012 (12)
December 2011 (18)
November 2011 (20)
October 2011 (27)
September 2011 (17)
August 2011 (18)
July 2011 (45)
June 2011 (22)
May 2011 (23)
April 2011 (19)
March 2011 (36)
February 2011 (19)
January 2011 (22)
December 2010 (29)
November 2010 (37)
October 2010 (32)
September 2010 (43)
August 2010 (46)
July 2010 (37)
June 2010 (46)
May 2010 (29)
April 2010 (38)
March 2010 (27)
February 2010 (33)
January 2010 (34)
December 2009 (13)
November 2009 (20)
October 2009 (29)
September 2009 (18)
August 2009 (29)
July 2009 (19)
June 2009 (18)
May 2009 (23)
April 2009 (16)
March 2009 (13)
February 2009 (20)
January 2009 (25)
December 2008 (25)
November 2008 (29)
October 2008 (34)
September 2008 (33)
August 2008 (36)
July 2008 (31)
June 2008 (25)
May 2008 (26)
April 2008 (33)
March 2008 (31)
February 2008 (24)
January 2008 (18)
December 2007 (27)
November 2007 (51)
October 2007 (24)
September 2007 (32)
August 2007 (24)
July 2007 (20)
June 2007 (28)
May 2007 (27)
April 2007 (24)
March 2007 (47)
February 2007 (21)
January 2007 (41)
December 2006 (21)
November 2006 (16)
October 2006 (24)
September 2006 (36)
August 2006 (30)
July 2006 (31)
June 2006 (37)
May 2006 (13)
April 2006 (13)
March 2006 (18)
February 2006 (20)
January 2006 (13)
December 2005 (6)
November 2005 (15)
October 2005 (15)
September 2005 (16)
August 2005 (7)
April 2005 (1)
March 2004 (4)
February 2004 (6)
January 2004 (1)
November 2003 (4)
October 2003 (22)
September 2003 (22)
August 2003 (15)
July 2003 (14)

Copyright 2014 by DNN Corp | Terms of Use | Privacy | Design by Parker Moore Design