Skip to main content

Dynamic data type in WCF services (Using KnownType Attribute)

Here i am going to explain how to return dynamic or runtime data type from WCF services,
In WCF you find a attribute named KnowType, this attribute is for telling the service that what is the possible return type of the method so thatWCF create a proxy of these types in refrence.cs file.

How to Use :-
You need to create a base type class as given below BaseDataType and define KnowType attribute here as the possible types of this base type class like type of User and type of Division etc.

[DataContract]
[Serializable]
[KnownType(typeof(User))]
[KnownType(typeof(Division))]
[KnownType(typeof(Workgroup))]
[KnownType(typeof(Document))]
[KnownType(typeof(GlobalIndexField))]
[KnownType(typeof(IndexFieldGroup))]
[KnownType(typeof(FileFormat))]
[KnownType(typeof(FileOperation))]
[KnownType(typeof(Platform))]
[KnownType(typeof(ProfileProgram))]
[KnownType(typeof(UserProfile))]
[KnownType(typeof(Annotation))]
[KnownType(typeof(Workflow))]
[KnownType(typeof(ReproDevice))]
[KnownType(typeof(Media))]
[KnownType(typeof(ProgramName))]
public abstract class BaseDataType
{

}

Then created a class that contains BaseDataType as given DynamicData below or you can direct return BaseDataType from your operation contract.

[DataContract]
[Serializable]
 public class DynamicData
 {
     public IList<BaseDataType> Data { getset; }   
 }


Each and every class that you need to return from service (need to include in dynamic DataContract) must be inherited with BaseDataType (must be type of BaseDataType).

 [DataContract]
  [Serializable]
  public class User : BaseDataType
  {

 [DataContract]
  [Serializable]
  public class Division : BaseDataType
  {

 [DataContract]
  [Serializable]
  public class Workgroup : BaseDataType
  {


Create an operation contract that returns dynamic type (i.e direct BaseDataType or DynamicData type) write your functionality here return any dynamic data that you already defined in the KnowType attribute and map it with the BaseDataType as given below.

public DynamicData SearchInIndex(AppEnums.GlobalSearchType searchType,string searchKey)
{
    dynamic dynamicResult;
    switch (searchType)
    {
        case AppEnums.GlobalSearchType.Database:
            dynamicResult= SearchInIndexByDatabase(searchKey);
            break;
        case AppEnums.GlobalSearchType.ElasticSearch:
            dynamicResult= SearchInIndexByElasticSearch(searchKey);
            break;
        default:
            throw new NotImplementedException();
    }
    return MapData(dynamicResult);

}

 public DynamicData MapData(dynamic data)
 {
    DynamicData dynamicResult = new DynamicData();
    dynamicResult.Data = new List<BaseDataType>();
    foreach (var item in data)
    {
       dynamicResult.Data.Add((BaseDataType)item);
    }
    return dynamicResult;
 }

you can directly return BaseDataType from the operation contract.
public List<BaseDataType> SearchInIndex(AppEnums.GlobalSearchType searchType,string searchKey)
{
    dynamic dynamicResult;
    switch (searchType)
    {
        case AppEnums.GlobalSearchType.Database:
            dynamicResult= SearchInIndexByDatabase(searchKey);
            break;
        case AppEnums.GlobalSearchType.ElasticSearch:
            dynamicResult= SearchInIndexByElasticSearch(searchKey);
            break;
        default:
            throw new NotImplementedException();
    }
    return MapData(dynamicResult);

}

 public List<BaseDataType> MapData(dynamic data)
 {
    List<BaseDataType> dynamicResult = new List<BaseDataType>();
    foreach (var item in data)
    {
       dynamicResult.Add((BaseDataType)item);
    }
    return dynamicResult;
 }



Popular posts from this blog

Merging multiple PDFs using iTextSharp in asp.net c#

In this article i will show you how to merge multiple pdfs into one using ITextSharp below is the two approach one is to pass your input files path, output file path (will be created if not exist) and another is pass direct input stream, output stream and it will write the merge files into output stream.

how $document.ready() is different from window.onload()

we often use window.onload() in javascript and $document.ready() in jquery and assume that both are same just jquery library wrap up javascript window.onload() and introduce $document.ready() but no there is much difference between them below is the explanation -

Uploading large file in chunks in Asp.net Mvc c# from Javascript ajax

Often we have a requirement to upload files in Asp.net, Mvc c# application but when it comes to uploading larger file, we always think how to do it as uploading large file in one go have many challenges like UI responsiveness, If network fluctuate for a moment in between then uploading task get breaks and user have to upload it again etc.

Scrollable Gridview with fixed headers in asp.net

horizontal and vertical scrollable Gridview with static header row.fixed header in gridview in asp.net.static header in gridview through java script.I was looking for a solution for this for a long time and found most of the answers are not working or not suitable for my situation i also find most of the java script code for that they worked but only with the vertical scroll not with the horizontal scroll and also combination of header and rows doesn't match.