Developer's Guide - EPiServer World

More documents

Recommendations

Info

18 | Developer’s Guide EPiServer Community 3.1 2.5 Attributes The Attriibute system allows for developers to setting attributes and attributes values of primitive and complex types to any object that implements the IAttributeExtendableEntiry interface. This provides a fast and flexible way to extend EPiServer Community classes. The name of the attribute must be pre-defined in the database. This is commonly done via the administration interface. The attribute name must be unique within a type. Note that this tutorial only describes the most elementary way to use attributes. A more object-oriented approach is to create a custom class derived from Blog that expose fixed properties. This would call for creating your own EntityProvider as explained in section 1.2.4 First import the necessary namespaces: using StarCommunity.Core.Modules.Attributes; using StarCommunity.Modules.Blog; //only for this example. 2.5.1 Setting attribute values In this example we set a DateTime and a DocumentArchive attribute to a blog: //Get the blog for which set the attributes Blog blog = (Blog)BlogHandler.GetBlog(1).Clone(); //Set a DateTime attribute that contains a last updated date blog.SetAttributeValue("attr_last_updated", DateTime.Now); //Get the document archive to use DocumentArchive da = DocumentArchiveHandler.GetDocumentArchive(123); //Set a DocumentArchive as an attribute to the blog blog.SetAttributeValue("attr_archive", da); 2.5.2 Getting attribute values //Get the blog for wich we want the attriute values Blog blog = BlogHandler.GetBlog(1); //Get the last updated attribute DateTime lastUpdated = blog.GetAttributeValue("attr_last_updated“); //Get the document archive attribute DocumentArchive da = blog.GetAttributeValue("attr_archive"); © EPiServer AB
Tutorials | 19 2.6 Queries The Query system allows for dynamically creating a set of criteria that should applied to a certain type before retrieving it. A criterion can have an infinite amount of sub-criteria which in turn has their own sub-criteria. Queries like “return all Clubs with more than 10 members, with a member age range between 25 and 30 years.” are now possible, and that’s just one of the simple queries possible to compose. All relevant EPiServer Community classes are retrievable and can be filtered on. Note that this tutorial uses the Query system in the most elementary way. To read more about attributes, queries and system design, please refer to section 0. First import the necessary namespaces: Using StarSuite.Core.Modules.Sorting; using StarCommunity.Core.Modules.Queries; using StarCommunity.Modules.Blog; //only for this example. 2.6.1 Filter and and sort EPiServer Community objects In this example we want all blogs with the name “blog test” and that have 7 entries, ordered by author name ascending. Note that the criteria may be nested, as is the case with the author name. //Create a new BlogQuery BlogQuerybq = new BlogQuery() //Initialize criterions bq.Name = new StringCriterion(); bq.NumEntries = new IntegerCriterion(); bq.Author = new AuthorCriterion(); bq.Author.Name = new StringCriterion(); //Set values to filter on bq.Name.Value = "Blog Test"; bq.NumEntries.Value = 7; //Order by author name bq.OrderBy.Add( new CriterionSortOrder(bq.Author.Name, SortingDirection.Ascending)); //Get the filtered blog collection BlogCollection blogs = BlogHandler.GetQueryResult(bq); © EPiServer AB
Page 1 and 2: Release 3.1.0 Developer’s Guide
Page 3 and 4: Table of Contents | 3 Table of Cont
Page 5 and 6: Basic Understanding | 5 2.10.5 Addi
Page 7 and 8: Basic Understanding | 7 1 Basic Und
Page 9 and 10: Basic Understanding | 9 1.2.2 EPiSe
Page 11 and 12: Basic Understanding | 11 StarCommun
Page 13 and 14: Basic Understanding | 13 1.2.4 EPiS
Page 15 and 16: Basic Understanding | 15 If MyClass
Page 17 and 18: Basic Understanding | 17 1.3.4 Star
Page 19 and 20: Basic Understanding | 19 1.3.18 Sta
Page 21 and 22: Table of Contents | 3 2 Tutorials 2
Page 23 and 24: Tutorials | 5 Note that when changi
Page 25 and 26: Tutorials | 7 IUser user = (IUser)S
Page 27 and 28: Tutorials | 9 user.BirthDate = new
Page 29 and 30: Tutorials | 11 Attaching the Group
Page 31 and 32: Tutorials | 13 The Tag object is de
Page 33 and 34: Tutorials | 15 2.3.4 Retrieving ent
Page 35: Tutorials | 17 //Get the category b
Page 39 and 40: Tutorials | 21 2.6.4 Remove Query R
Page 41 and 42: Tutorials | 23 // Create a blog ent
Page 43 and 44: Tutorials | 25 Below an example of
Page 45 and 46: Tutorials | 27 The logging frequenc
Page 47 and 48: Tutorials | 29 Committing the chang
Page 49 and 50: Tutorials | 31 Get All Blog Entries
Page 51 and 52: Tutorials | 33 2.10 Calendar Calend
Page 53 and 54: Tutorials | 35 Create a New Event C
Page 55 and 56: Tutorials | 37 Create Recurrent Eve
Page 57 and 58: Tutorials | 39 Import Necessary Nam
Page 59 and 60: Tutorials | 41 2.11 Chat The Chat M
Page 61 and 62: Tutorials | 43 2.11.2 Base The base
Page 63 and 64: Tutorials | 45 2.11.5 MessageBox Th
Page 65 and 66: Tutorials | 47 2.12.2 Removing a Cl
Page 67 and 68: Tutorials | 49 Adding an Ad with an
Page 69 and 70: Tutorials | 51 Import Necessary Nam
Page 71 and 72: Tutorials | 53 Get the contact rela
Page 73 and 74: Tutorials | 55 Then create a new Co
Page 75 and 76: Tutorials | 57 2.14.5 Configuration
Page 77 and 78: Tutorials | 59 Then we get the cont
Page 79 and 80: Tutorials | 61 To get a UserCollect
Page 81 and 82: Tutorials | 63 Now we are ready to
Page 83 and 84: Tutorials | 65 Folder inbox = dmc.G
Page 85 and 86: Tutorials | 67 Then we remove it: D
Page 87 and 88:
Tutorials | 69 2.17.6 Configuration
Page 89 and 90:
Tutorials | 71 2.18.2 Add a Member
Page 91 and 92:
Tutorials | 73 Check if a User is a
Page 93 and 94:
Tutorials | 75 Assign a Question To
Page 95 and 96:
Tutorials | 77 Get Questions Assign
Page 97 and 98:
Tutorials | 79 2.19 Forum Forums ar
Page 99 and 100:
Tutorials | 81 Locking the Topic To
Page 101 and 102:
Tutorials | 83 2.19.7 Removing a Re
Page 103 and 104:
Tutorials | 85 First we need the Im
Page 105 and 106:
Tutorials | 87 To begin with, we ne
Page 107 and 108:
Tutorials | 89 2.21 Moblog The Mobl
Page 109 and 110:
Tutorials | 91 2.22 MyPage The EPiS
Page 111 and 112:
Tutorials | 93 Getting Blocked User
Page 113 and 114:
Tutorials | 95 2.23 NML NML is a ma
Page 115 and 116:
Tutorials | 97 Limiting Maximum Wor
Page 117 and 118:
Tutorials | 99 Getting a User’s L
Page 119 and 120:
Tutorials | 101 Add a Poll In this
Page 121 and 122:
Tutorials | 103 Voting in a Poll To
Page 123 and 124:
Tutorials | 105 2.25.6 Add Choices
Page 125 and 126:
Tutorials | 107 Import Necessary Na
Page 127 and 128:
Tutorials | 109 2.27.2 Adding video
Page 129 and 130:
Tutorials | 111 Calling AddVideo pr
Page 131 and 132:
Tutorials | 113 2.27.6 Get preview
Page 133 and 134:
Tutorials | 115 2.28 Webmail Webmai
Page 135 and 136:
Tutorials | 117 Import Necessary Na
Page 137 and 138:
Tutorials | 119 Accessing a Mailbox
Page 139 and 140:
Tutorials | 121 Note that it is rec
Page 141 and 142:
Extending EPiServer Community | 123
Page 143 and 144:
Page 145 and 146:
Page 147 and 148:
Page 149 and 150:
show all

Developer's Guide - EPiServer World

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?