Working with URIs and Fragments in C#: Manipulating the `Uri.Fragment` Property

Learn how to effectively work with URIs and their fragments in C#. This tutorial explains how to access and modify the fragment part of a URI using the `Uri.Fragment` property and `UriBuilder` class, enabling precise control over target locations within web resources.

Working with URIs and Fragments in C# using `Uri.Fragment`

Understanding URIs and Fragments

URIs (Uniform Resource Identifiers) are used to identify resources on the web. A URI can include a fragment, which is a part of the URI indicated by a hash symbol (#). The fragment specifies a particular section or location within the resource. When a browser encounters a URI with a fragment, it navigates to the resource and then scrolls to or highlights the specific section indicated by the fragment.

The `Uri.Fragment` Property

The `Uri.Fragment` property in C# provides a way to access and manipulate the fragment part of a URI. It allows you to get the existing fragment or modify it to change the target location within a resource.

`Uri.Fragment` Syntax

The syntax for accessing the `Uri.Fragment` property is:

public string Fragment { get; }

This is a read-only property, meaning you can only retrieve the fragment. To modify a URI's fragment, you need to use the `UriBuilder` class.

Example: Using `Uri.Fragment`

This C# example demonstrates retrieving and modifying URI fragments using the `Uri` and `UriBuilder` classes.

C# Code

using System;

public class UriExample {
    public static void Main(string[] args) {
        string uriString1 = "https://example.com/page#section1";
        Uri uri1 = new Uri(uriString1);
        string fragment1 = uri1.Fragment;
        Console.WriteLine($"Example 1 - Fragment: {fragment1}");

        string uriString2 = "https://example.com/page#section1";
        Uri originalUri2 = new Uri(uriString2);
        string newFragment2 = "section2";
        Uri modifiedUri2 = new UriBuilder(originalUri2) { Fragment = newFragment2 }.Uri;
        Console.WriteLine($"Example 2 - Original URI: {originalUri2}");
        Console.WriteLine($"Example 2 - Modified URI: {modifiedUri2}");

        string uriString3 = "https://example.com/page";
        Uri uri3 = new Uri(uriString3);
        bool hasFragment3 = !string.IsNullOrEmpty(uri3.Fragment);
        Console.WriteLine($"Example 3 - Has Fragment: {hasFragment3}");
    }
}

    

Applications of `Uri.Fragment`

Extracting Fragments: Easily retrieve the fragment from a URI.
Modifying Fragments: Use `UriBuilder` to change a URI's fragment.
Checking for Fragments: Determine if a URI contains a fragment.
Conditional Fragment Handling: Use conditional logic based on the presence of a fragment.

Best Practices and Considerations

URI Validation: Always validate URI format before use to prevent errors.
Handling Relative URIs: Be mindful of the base URI when dealing with relative URIs.
Encoding and Decoding: Handle encoding and decoding carefully when dealing with special characters.
Security: Avoid relying solely on client-side fragments for security-sensitive operations.

Conclusion

The `Uri.Fragment` property is a valuable tool for working with URIs in C#. By understanding its capabilities and limitations and following best practices, you can efficiently manage and manipulate URI fragments in your C# applications.

Follow On

TutorialsArena