Class DictionaryExtensions

Namespace: Cuemon.Extensions.Net

Assembly: Cuemon.Extensions.Net.dll

Extension methods for the IDictionary<TKey, TValue> interface.

public static class DictionaryExtensions

Inheritance: object

DictionaryExtensions

Examples

DictionaryExtensions in the Net namespace converts Dictionary<string, string[]> into URL query strings with optional percent-encoding. This example creates a dictionary with parameters "search": ["dotnet"], "page": ["1"], and "tags": ["aspnet", "core"], then calls ToQueryString() to produce search=dotnet&page=1&tags=aspnet&tags=core and ToQueryString(urlEncode: true) for URL-encoded output. It also handles an empty dictionary that returns an empty string. Console output shows the raw query string, the encoded variant, and the empty-collection result "Empty: ''".

using System;
using System.Collections.Generic;
using Cuemon.Extensions.Net;

namespace MyApp.Net
{
    public class DictionaryExtensionsExample
    {
        public void Demonstrate()
        {
            // Build a query string from a dictionary
            var parameters = new Dictionary<string, string[]>
            {
                { "search", new[] { "dotnet" } },
                { "page", new[] { "1" } },
                { "tags", new[] { "aspnet", "core" } }
            };

            // Convert to a query string (not URL-encoded)
            string queryString = parameters.ToQueryString();
            Console.WriteLine(queryString);
            // Output: search=dotnet&page=1&tags=aspnet&tags=core

            // URL-encode the values
            string encoded = parameters.ToQueryString(urlEncode: true);
            Console.WriteLine(encoded);
            // Output: search=dotnet&page=1&tags=aspnet&tags=core

            // Useful for building API request URLs
            var empty = new Dictionary<string, string[]>();
            string emptyQs = empty.ToQueryString();
            Console.WriteLine($"Empty: '{emptyQs}'"); // Empty: ''

}}
}

Methods

ToQueryString(IDictionary<string, string[]>, bool)

Converts the specified query into its string equivalent.

public static string ToQueryString(this IDictionary<string, string[]> query, bool urlEncode = false)

Parameters

query IDictionary<string, string[]>: The IDictionary<TKey, TValue> to extend.
urlEncode bool: Specify true to encode the query into a URL-encoded string; otherwise, false. Default is false.

Returns